Package com.atlassian.bamboo.chains

Interface ChainStageResult

All Superinterfaces:

BambooIdProvider, BambooObject, Describable, DescriptionProvider, NameProvider

All Known Implementing Classes:

ChainStageResultImpl

@PublicApi
public interface ChainStageResult
extends BambooObject, Describable

Represents the result of a ChainStage execution

Since:

2.7

Method Summary

Modifier and Type	Method	Description
boolean	addBuildResult(@NotNull BuildResultsSummary buildResult)	Adds a BuildResultsSummary and sets the relationship to the ChainResultsSummary
void	addManualVariable(@NotNull StageVariableContext stageVariableContext)
@NotNull Set<BuildResultsSummary>	getBuildResults()	Returns all the BuildResultsSummary with this Stage result
@NotNull ChainResultsSummary	getChainResult()	Returns the ChainResultsSummary associated with this Stage result
@NotNull Collection<BuildResultsSummary>	getFailedBuildResults()	Returns all the failed BuildResultsSummary with this Stage result
LifeCycleState	getLifeCycleState()
@NotNull List<StageVariableContext>	getManualVariables()	Get manual variables that were set before this stage started.
@NotNull List<StageVariableContext>	getManualVariablesEncrypted()	Since 7.0.
long	getProcessingDuration()	Processing duration of stage (time of longest job in stage execution)
@NotNull List<BuildResultsSummary>	getSortedBuildResults()	Returns all the BuildResultsSummary with this Stage result ordered by build name.
BuildState	getState()
@NotNull Collection<BuildResultsSummary>	getSuccessfulBuildResults()	Returns all the successful BuildResultsSummary with this Stage result
boolean	isAllJobsExist()
boolean	isAllNotSuccessfulJobsExist()
boolean	isCompleted()
boolean	isFailed()
boolean	isFinal()
boolean	isFinished()
boolean	isManual()	Checks if result as manual (at the time of result creation) Manual means stage execution is hold and waits for user interaction
boolean	isNotBuilt()	Checks if the stage has unbuilt jobs inside it
boolean	isPending()
boolean	isRestartable()	Checks if plan nas been failed and could be restarted on the stage where failed
boolean	isRunnable()	Checks if current stage if first manual stage waiting for execution (chain is completed on previous stage and waiting for this stage to execute)
boolean	isSuccessful()
boolean	removeBuildResult(@NotNull BuildResultsSummary buildResult)	Removes a BuildResultsSummary
void	setChainResult(@NotNull ChainResultsSummary chainResult)	Sets the ChainResultsSummary associated with this Stage result
void	setFinal(boolean finalStage)
void	setManual(boolean manual)	Marks result as optional (at the time of result creation) Manual means stage execution is hold and waits for user interaction
void	setProcessingDuration(long processingDuration)

Methods inherited from interface com.atlassian.bamboo.core.BambooIdProvider

getId

Methods inherited from interface com.atlassian.bamboo.core.BambooObject

setId

Methods inherited from interface com.atlassian.bamboo.Describable

setDescription, setName

Methods inherited from interface com.atlassian.bamboo.utils.DescriptionProvider

getDescription, getName

Method Detail

getChainResult

@NotNull
@NotNull ChainResultsSummary getChainResult()

Returns the ChainResultsSummary associated with this Stage result

Returns:

chainResult

setChainResult

void setChainResult(@NotNull
                    @NotNull ChainResultsSummary chainResult)

Sets the ChainResultsSummary associated with this Stage result

Parameters:

chainResult -

getBuildResults

@NotNull
@NotNull Set<BuildResultsSummary> getBuildResults()

Returns all the BuildResultsSummary with this Stage result

Returns:

results

getSortedBuildResults

@NotNull
@NotNull List<BuildResultsSummary> getSortedBuildResults()

Returns all the BuildResultsSummary with this Stage result ordered by build name. WARNING: Dont use in performance critical situations.

Returns:

results

getFailedBuildResults

@NotNull
@NotNull Collection<BuildResultsSummary> getFailedBuildResults()

Returns all the failed BuildResultsSummary with this Stage result

Returns:

results

getSuccessfulBuildResults

@NotNull
@NotNull Collection<BuildResultsSummary> getSuccessfulBuildResults()

Returns all the successful BuildResultsSummary with this Stage result

Returns:

results

addBuildResult

boolean addBuildResult(@NotNull
                       @NotNull BuildResultsSummary buildResult)

Adds a BuildResultsSummary and sets the relationship to the ChainResultsSummary

Parameters:

buildResult -

Returns:

success

removeBuildResult

boolean removeBuildResult(@NotNull
                          @NotNull BuildResultsSummary buildResult)

Removes a BuildResultsSummary

Parameters:

buildResult -

Returns:

success

isPending

boolean isPending()

isCompleted

boolean isCompleted()

isAllJobsExist

boolean isAllJobsExist()

Returns:

true iff all the jobs in this stage result still exist

Since:

6.9

isAllNotSuccessfulJobsExist

boolean isAllNotSuccessfulJobsExist()

Returns:

true iff all the jobs in this stage result that are not finished successfully still exist

Since:

6.9

isSuccessful

boolean isSuccessful()

isFailed

boolean isFailed()

isFinished

boolean isFinished()

getState

BuildState getState()

getLifeCycleState

LifeCycleState getLifeCycleState()

isManual

boolean isManual()

Checks if result as manual (at the time of result creation) Manual means stage execution is hold and waits for user interaction

Returns:

true if manual

setManual

void setManual(boolean manual)

Marks result as optional (at the time of result creation) Manual means stage execution is hold and waits for user interaction

isFinal

boolean isFinal()

setFinal

void setFinal(boolean finalStage)

isRunnable

boolean isRunnable()

Checks if current stage if first manual stage waiting for execution (chain is completed on previous stage and waiting for this stage to execute)

Returns:

true if stage is ready and allowed for manual execution

isRestartable

boolean isRestartable()

Checks if plan nas been failed and could be restarted on the stage where failed

isNotBuilt

boolean isNotBuilt()

Checks if the stage has unbuilt jobs inside it

Returns:

getProcessingDuration

long getProcessingDuration()

Processing duration of stage (time of longest job in stage execution)

Returns:

setProcessingDuration

void setProcessingDuration(long processingDuration)

Parameters:

processingDuration -

getManualVariables

@NotNull
@NotNull List<StageVariableContext> getManualVariables()

Get manual variables that were set before this stage started. This contains only the variables that changed compared to the previous stage.

Since:

5.7

addManualVariable

void addManualVariable(@NotNull
                       @NotNull StageVariableContext stageVariableContext)

getManualVariablesEncrypted

@Internal
@NotNull
@NotNull List<StageVariableContext> getManualVariablesEncrypted()

Since 7.0. For internal use only. Use getManualVariables() or addManualVariable(StageVariableContext) instead.