Package com.atlassian.bamboo.chains

Interface StageExecution

@PublicApi public interface StageExecution
Represents a ChainStage executing within a Chain

  • Method Details

    • getStageIndex

      int getStageIndex()
      Index of the ChainStage within the current Chain
      Returns:
      0-based index of the stage

    • getChainExecution

      @NotNull @NotNull ChainExecution getChainExecution()
      Gets the ChainExecution that the StageExecution is a member of
      Returns:
      chainExecution

    • getName

      @NotNull @NotNull String getName()
      Gets the name of the Stage
      Returns:
      name

    • getDescription

      @Nullable @Nullable String getDescription()
      Gets the description of the Stage
      Returns:
      description

    • isBuilding

      boolean isBuilding()
      If the Stage is building or not
      Returns:
      building

    • isCompleted

      boolean isCompleted()
      If the Stage has completed or not
      Returns:
      completed

    • isSuccessful

      boolean isSuccessful()
      If the Stage is successful or not
      Returns:
      successful

    • getBuilds

      @NotNull @NotNull List<BuildExecution> getBuilds()
      Returns the BuildExecution's that are executed during this stage
      Returns:
      builds

    • getExecutionContext

      @NotNull @NotNull ExecutionContext getExecutionContext()
      Stores contextual data for the current StageExecution
      Returns:
      executionContext