Package io.jenkins.blueocean.rest.model

Interface BlueContainerItem

All Known Implementing Classes:
BlueMultiBranchPipeline, BlueOrganizationFolder, BluePipelineFolder
public interface BlueContainerItem
Common interface for items in the pipeline "namespace" that aggregate or contain other pipeline items, such as team or organization folders, or the collection of pipelines that forms a BlueMultiBranchItem.

These may or may not be also runnable, so we want to keep that facet in BlueRunnableItem and not here.

  • Method Details

    • getPipelines

      BluePipelineContainer getPipelines()
      Returns:
      Gives pipeline container

    • getDynamic

      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)
      Parameters:
      name - name of pipeline
      Returns:
      a BluePipeline

    • getNumberOfFolders

      @Exported(name="numberOfFolders") Integer getNumberOfFolders()
      Returns:
      Number of folders in this folder

    • getNumberOfPipelines

      @Exported(name="numberOfPipelines") Integer getNumberOfPipelines()
      Returns:
      Number of pipelines in this folder. Pipeline is any buildable type.

    • getIcon

      @Exported(skipNull=true) BlueIcon getIcon()

    • getPipelineFolderNames

      @Exported(name="pipelineFolderNames") Iterable<String> getPipelineFolderNames()
      Returns pipeline folder names present in this folder.