Package io.jenkins.blueocean.rest.model

Class BlueMultiBranchPipeline

java.lang.Object

io.jenkins.blueocean.rest.model.Resource

io.jenkins.blueocean.rest.model.BluePipeline

io.jenkins.blueocean.rest.model.BluePipelineFolder

io.jenkins.blueocean.rest.model.BlueMultiBranchPipeline

All Implemented Interfaces:

BlueContainerItem, BlueManagedSource, BlueMultiBranchItem, BluePipelineItem, BlueRunnableItem, Reachable

public abstract class BlueMultiBranchPipeline
extends BluePipelineFolder
implements BlueMultiBranchItem

Multi-branch pipeline model

Author:

Vivek Pandey

Field Summary

Fields

Modifier and Type	Field	Description
static String	BRANCH_NAMES
static String	NUMBER_OF_FAILING_BRANCHES
static String	NUMBER_OF_FAILING_PULL_REQUESTS
static String	NUMBER_OF_SUCCESSFUL_BRANCHES
static String	NUMBER_OF_SUCCESSFUL_PULL_REQUESTS
static String	SCM_SOURCE
static String	TOTAL_NUMBER_OF_BRANCHES
static String	TOTAL_NUMBER_OF_PULL_REQUESTS

Fields inherited from class io.jenkins.blueocean.rest.model.BluePipeline

ACTIONS, CONFIGURE_PERMISSION, CREATE_PERMISSION, DISABLED, DISPLAY_NAME, ESTIMATED_DURATION, FULL_DISPLAY_NAME, FULL_NAME, LATEST_RUN, NAME, ORGANIZATION, PERMISSIONS, READ_PERMISSION, START_PERMISSION, STOP_PERMISSION, WEATHER_SCORE

Constructor Summary

Constructors

Constructor	Description
BlueMultiBranchPipeline()

Method Summary

Modifier and Type	Method	Description
abstract BluePipelineContainer	getBranches()
abstract Collection<String>	getBranchNames()
abstract int	getNumberOfFailingBranches()
abstract int	getNumberOfFailingPullRequests()
abstract int	getNumberOfSuccessfulBranches()
abstract int	getNumberOfSuccessfulPullRequests()
Iterable<String>	getPipelineFolderNames()	MultiBranch pipeline is computed folder, no sub-folders in it
BlueRunContainer	getRuns()
abstract BlueScmSource	getScmSource()	Get metadata about the SCM for this pipeline.
abstract int	getTotalNumberOfBranches()
abstract int	getTotalNumberOfPullRequests()

Methods inherited from class io.jenkins.blueocean.rest.model.BluePipelineFolder

getDynamic, getEstimatedDurationInMillis, getIcon, getLatestRun, getNumberOfFolders, getNumberOfPipelines, getPipelines, getQueue, getWeatherScore

Methods inherited from class io.jenkins.blueocean.rest.model.BluePipeline

disable, enable, favorite, getActions, getDisabled, getDisplayName, getFullDisplayName, getFullName, getName, getOrganization, getOrganizationName, getParameters, getPermissions, getScm, getTrends

Methods inherited from class io.jenkins.blueocean.rest.model.Resource

getLinks, getState

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.jenkins.blueocean.rest.Reachable

getLink

Field Detail

TOTAL_NUMBER_OF_BRANCHES

public static final String TOTAL_NUMBER_OF_BRANCHES

See Also:

Constant Field Values

NUMBER_OF_FAILING_BRANCHES

public static final String NUMBER_OF_FAILING_BRANCHES

See Also:

Constant Field Values

NUMBER_OF_SUCCESSFUL_BRANCHES

public static final String NUMBER_OF_SUCCESSFUL_BRANCHES

See Also:

Constant Field Values

TOTAL_NUMBER_OF_PULL_REQUESTS

public static final String TOTAL_NUMBER_OF_PULL_REQUESTS

See Also:

Constant Field Values

NUMBER_OF_FAILING_PULL_REQUESTS

public static final String NUMBER_OF_FAILING_PULL_REQUESTS

See Also:

Constant Field Values

NUMBER_OF_SUCCESSFUL_PULL_REQUESTS

public static final String NUMBER_OF_SUCCESSFUL_PULL_REQUESTS

See Also:

Constant Field Values

BRANCH_NAMES

public static final String BRANCH_NAMES

See Also:

Constant Field Values

SCM_SOURCE

public static final String SCM_SOURCE

See Also:

Constant Field Values

Constructor Detail

BlueMultiBranchPipeline

public BlueMultiBranchPipeline()

Method Detail

getTotalNumberOfBranches

@Exported(name="totalNumberOfBranches")
public abstract int getTotalNumberOfBranches()

Specified by:

getTotalNumberOfBranches in interface BlueMultiBranchItem

Returns:

total number of branches

getNumberOfFailingBranches

@Exported(name="numberOfFailingBranches")
public abstract int getNumberOfFailingBranches()

Specified by:

getNumberOfFailingBranches in interface BlueMultiBranchItem

Returns:

total number of failing branches

getNumberOfSuccessfulBranches

@Exported(name="numberOfSuccessfulBranches")
public abstract int getNumberOfSuccessfulBranches()

Specified by:

getNumberOfSuccessfulBranches in interface BlueMultiBranchItem

Returns:

total number of successful branches

getTotalNumberOfPullRequests

@Exported(name="totalNumberOfPullRequests")
public abstract int getTotalNumberOfPullRequests()

Specified by:

getTotalNumberOfPullRequests in interface BlueMultiBranchItem

Returns:

total number of pull requests

getNumberOfFailingPullRequests

@Exported(name="numberOfFailingPullRequests")
public abstract int getNumberOfFailingPullRequests()

Specified by:

getNumberOfFailingPullRequests in interface BlueMultiBranchItem

Returns:

total number of pull requests

getNumberOfSuccessfulPullRequests

@Exported(name="numberOfSuccessfulPullRequests")
public abstract int getNumberOfSuccessfulPullRequests()

Specified by:

getNumberOfSuccessfulPullRequests in interface BlueMultiBranchItem

Returns:

total number of pull requests

getBranches

public abstract BluePipelineContainer getBranches()

Specified by:

getBranches in interface BlueMultiBranchItem

Returns:

Gives BluePipelineContainer

getBranchNames

@Exported(name="branchNames")
public abstract Collection<String> getBranchNames()

Specified by:

getBranchNames in interface BlueMultiBranchItem

Returns:

Gives array of branch names

getPipelineFolderNames

public Iterable<String> getPipelineFolderNames()

MultiBranch pipeline is computed folder, no sub-folders in it

Specified by:

getPipelineFolderNames in interface BlueContainerItem

Specified by:

getPipelineFolderNames in class BluePipelineFolder

getRuns

public BlueRunContainer getRuns()

Specified by:

getRuns in interface BlueRunnableItem

Overrides:

getRuns in class BluePipelineFolder

Returns:

It gives no-op BlueRunContainer since Multi-branch is not a build item, does not build on its own

getScmSource

@Exported(name="scmSource",
          inline=true)
public abstract BlueScmSource getScmSource()

Get metadata about the SCM for this pipeline.