Package com.atlassian.bamboo.chains

Interface StageState

@Internal
public interface StageState

Method Summary

Modifier and Type	Method	Description
void	addResultVariablesFromPreviousStages(@NotNull Map<String,VariableDefinitionContext> resultVariables)	Updates build context of all jobs in this stage with result variables collected in previous stage(s).
@Nullable ChainBuildState	get(@NotNull PlanResultKey planResultKey)	Gets the Build State given the build result key
@NotNull Collection<ChainBuildState>	getBuilds()	Get Builds associated with this Stage
Long	getChainStageResultId()	The id of the ChainStageResult
@Nullable String	getDescription()	Get the Stage description
@NotNull ExecutionContext	getExecutionContext()	Stores contextual data for the current StageState
@NotNull String	getName()	Get Stage name
int	getStageIndex()	Index of the ChainStage within the current Chain
boolean	isBuilding()	Checks if the stage is building
boolean	isCompleted()	Checks if the stage has been marked as completed
boolean	isFailed()	Checks if the stage has failed
boolean	isFinal()
boolean	isManual()
boolean	isSuccessful()	Checks if the stage has completed successfully
boolean	isWaiting()	Checks if the stage is waiting to be executed
void	setPublishedChainArtifactsInfo(@NotNull com.google.common.collect.Multimap<String,Artifact> publishedChainArtifacts)	Updates build context of all jobs in this stage with artifacts published in previous stage(s).
void	setSkipped(boolean skipped)

Method Detail

getChainStageResultId

Long getChainStageResultId()

The id of the ChainStageResult

Returns:

id

getStageIndex

int getStageIndex()

Index of the ChainStage within the current Chain

Returns:

0-based index of the stage

getName

@NotNull
@NotNull String getName()

Get Stage name

Returns:

name

getDescription

@Nullable
@Nullable String getDescription()

Get the Stage description

Returns:

description

getBuilds

@NotNull
@NotNull Collection<ChainBuildState> getBuilds()

Get Builds associated with this Stage

Returns:

builds

isWaiting

boolean isWaiting()

Checks if the stage is waiting to be executed

Returns:

waiting

isBuilding

boolean isBuilding()

Checks if the stage is building

Returns:

building

isCompleted

boolean isCompleted()

Checks if the stage has been marked as completed

Returns:

completed

isSuccessful

boolean isSuccessful()

Checks if the stage has completed successfully

Returns:

success

isFailed

boolean isFailed()

Checks if the stage has failed

Returns:

failure

get

@Nullable
@Nullable ChainBuildState get(@NotNull
                              @NotNull PlanResultKey planResultKey)

Gets the Build State given the build result key

Parameters:

planResultKey -

Returns:

buildState

setSkipped

void setSkipped(boolean skipped)

getExecutionContext

@NotNull
@NotNull ExecutionContext getExecutionContext()

Stores contextual data for the current StageState

Returns:

executionContext

isManual

boolean isManual()

isFinal

boolean isFinal()

addResultVariablesFromPreviousStages

void addResultVariablesFromPreviousStages(@NotNull
                                          @NotNull Map<String,VariableDefinitionContext> resultVariables)

Updates build context of all jobs in this stage with result variables collected in previous stage(s).

Parameters:

resultVariables -

setPublishedChainArtifactsInfo

void setPublishedChainArtifactsInfo(@NotNull
                                    @NotNull com.google.common.collect.Multimap<String,Artifact> publishedChainArtifacts)

Updates build context of all jobs in this stage with artifacts published in previous stage(s).

Parameters:

publishedChainArtifacts -