Package io.jenkins.blueocean.rest.model

Class BluePipelineFolder

java.lang.Object

io.jenkins.blueocean.rest.model.Resource

io.jenkins.blueocean.rest.model.BluePipeline

io.jenkins.blueocean.rest.model.BluePipelineFolder

All Implemented Interfaces:

BlueContainerItem, BlueManagedSource, BluePipelineItem, BlueRunnableItem, Reachable

Direct Known Subclasses:

BlueMultiBranchPipeline, BlueOrganizationFolder

public abstract class BluePipelineFolder
extends BluePipeline
implements BlueContainerItem

Folder has pipelines, could also hold another BluePipelineFolders. BluePipelineFolder subclasses BluePipeline in order to handle recursive pipelines path: /pipelines/f1/pipelines/f2/pipelines/p1

Author:

Vivek Pandey

See Also:

• BluePipelineContainer

Field Summary

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
BluePipelineFolder()

Method Summary

Modifier and Type	Method	Description
BluePipeline	getDynamic(String name)	Gets nested BluePipeline inside the BluePipelineFolder For example for: /pipelines/folder1/pipelines/folder2/pipelines/p1, call sequence will be: getPipelines().get("folder1") getPipelines().get(folder2) getDynamics(p1)
Long	getEstimatedDurationInMillis()
abstract BlueIcon	getIcon()
BlueRun	getLatestRun()
abstract Integer	getNumberOfFolders()
abstract Integer	getNumberOfPipelines()
abstract Iterable<String>	getPipelineFolderNames()	Returns pipeline folder names present in this folder.
abstract BluePipelineContainer	getPipelines()
BlueQueueContainer	getQueue()
BlueRunContainer	getRuns()
Integer	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

Constructor Details

BluePipelineFolder

public BluePipelineFolder()

Method Details

getPipelines

public abstract BluePipelineContainer getPipelines()

Specified by:

getPipelines in interface BlueContainerItem

Returns:

Gives pipeline container

getDynamic

public BluePipeline getDynamic(String name)

Gets nested BluePipeline inside the BluePipelineFolder For example for: /pipelines/folder1/pipelines/folder2/pipelines/p1, call sequence will be:

• getPipelines().get("folder1")
• getPipelines().get(folder2)
• getDynamics(p1)

Specified by:

getDynamic in interface BlueContainerItem

Parameters:

name - name of pipeline

Returns:

a BluePipeline

getNumberOfFolders

@Exported(name="numberOfFolders")
public abstract Integer getNumberOfFolders()

Specified by:

getNumberOfFolders in interface BlueContainerItem

Returns:

Number of folders in this folder

getNumberOfPipelines

@Exported(name="numberOfPipelines")
public abstract Integer getNumberOfPipelines()

Specified by:

getNumberOfPipelines in interface BlueContainerItem

Returns:

Number of pipelines in this folder. Pipeline is any buildable type.

getWeatherScore

@Exported(skipNull=true)
public Integer getWeatherScore()

Specified by:

getWeatherScore in interface BlueRunnableItem

Specified by:

getWeatherScore in class BluePipeline

Returns:

weather health score percentile

getLatestRun

@Exported(skipNull=true)
public BlueRun getLatestRun()

Specified by:

getLatestRun in interface BlueRunnableItem

Specified by:

getLatestRun in class BluePipeline

Returns:

The Latest Run for the branch

getEstimatedDurationInMillis

@Exported(skipNull=true)
public Long getEstimatedDurationInMillis()

Specified by:

getEstimatedDurationInMillis in interface BlueRunnableItem

Specified by:

getEstimatedDurationInMillis in class BluePipeline

Returns:

Estimated duration based on last pipeline runs. -1 is returned if there is no estimate available.

getRuns

public BlueRunContainer getRuns()

Specified by:

getRuns in interface BlueRunnableItem

Specified by:

getRuns in class BluePipeline

Returns:

Gives Runs in this pipeline

getQueue

public BlueQueueContainer getQueue()

Specified by:

getQueue in interface BlueRunnableItem

Specified by:

getQueue in class BluePipeline

Returns:

Gives BlueQueueContainer

getIcon

@Exported(skipNull=true)
public abstract BlueIcon getIcon()

Specified by:

getIcon in interface BlueContainerItem

getPipelineFolderNames

@Exported(name="pipelineFolderNames")
public abstract Iterable<String> getPipelineFolderNames()

Returns pipeline folder names present in this folder.

Specified by:

getPipelineFolderNames in interface BlueContainerItem