Package com.atlassian.bamboo.chains
Interface StageExecution
-
@PublicApi public interface StageExecution
Represents aChainStage
executing within aChain
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description @NotNull List<BuildExecution>
getBuilds()
Returns theBuildExecution
's that are executed during this stage@NotNull ChainExecution
getChainExecution()
Gets theChainExecution
that theStageExecution
is a member of@Nullable String
getDescription()
Gets the description of the Stage@NotNull ExecutionContext
getExecutionContext()
Stores contextual data for the currentStageExecution
@NotNull String
getName()
Gets the name of the Stageint
getStageIndex()
Index of theChainStage
within the currentChain
boolean
isBuilding()
If the Stage is building or notboolean
isCompleted()
If the Stage has completed or notboolean
isSuccessful()
If the Stage is successful or not
-
-
-
Method Detail
-
getStageIndex
int getStageIndex()
Index of theChainStage
within the currentChain
- Returns:
- 0-based index of the stage
-
getChainExecution
@NotNull @NotNull ChainExecution getChainExecution()
Gets theChainExecution
that theStageExecution
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 theBuildExecution
's that are executed during this stage- Returns:
- builds
-
getExecutionContext
@NotNull @NotNull ExecutionContext getExecutionContext()
Stores contextual data for the currentStageExecution
- Returns:
- executionContext
-
-