Package com.atlassian.bamboo.chains

Interface ChainExecution

All Superinterfaces:

ExecutionStatus

@PublicApi
public interface ChainExecution
extends ExecutionStatus

Represents an executing Chain

Method Summary

Modifier and Type	Method	Description
<T> T	getConfigObject(String key, Class<T> aClass)	Get configuration object produced by PlanConfigurationUiPlugin
@Nullable StageExecution	getCurrentStage()	The current StageExecution
@NotNull ExecutionContext	getExecutionContext()	Stores contextual data for the current ChainExecution
@NotNull String	getName()	Gets the name of the executing Chain
@NotNull PlanResultKey	getPlanResultKey()	Get the result key
@NotNull List<StageExecution>	getStages()	Get Stages for this Chain
@NotNull TriggerReason	getTriggerReason()	Get the TriggerReason for the current ChainExecution
boolean	isCompleted()	Returns true if the chain has finished executing
boolean	isFailed()	Returns true if the chain execution has failed
boolean	isStopping()	Returns true if the chain is undergoing a 'stop' operation
boolean	isStopRequested()	Returns true if the Chain has been requested to stop execution
boolean	isSuccessful()	Returns true if the chain has finished executing successfully

Methods inherited from interface com.atlassian.bamboo.plan.ExecutionStatus

getAverageDuration, getBuildChanges, getBuildIdentifier, getElapsedTime, getProgressBar, getQueueTime, getStartTime

Method Detail

getName

@NotNull
@NotNull String getName()

Gets the name of the executing Chain

Returns:

name

getPlanResultKey

@NotNull
@NotNull PlanResultKey getPlanResultKey()

Get the result key

Returns:

resultKey

getStages

@NotNull
@NotNull List<StageExecution> getStages()

Get Stages for this Chain

Returns:

stages

isCompleted

boolean isCompleted()

Returns true if the chain has finished executing

Returns:

false

isSuccessful

boolean isSuccessful()

Returns true if the chain has finished executing successfully

Returns:

success

isFailed

boolean isFailed()

Returns true if the chain execution has failed

Returns:

failure

isStopping

boolean isStopping()

Returns true if the chain is undergoing a 'stop' operation

Returns:

stopping

isStopRequested

boolean isStopRequested()

Returns true if the Chain has been requested to stop execution

Returns:

stopRequested

getExecutionContext

@NotNull
@NotNull ExecutionContext getExecutionContext()

Stores contextual data for the current ChainExecution

Returns:

executionContext

getCurrentStage

@Nullable
@Nullable StageExecution getCurrentStage()

The current StageExecution

Returns:

stageExecution

getTriggerReason

@NotNull
@NotNull TriggerReason getTriggerReason()

Get the TriggerReason for the current ChainExecution

Specified by:

getTriggerReason in interface ExecutionStatus

Returns:

triggerReason

getConfigObject

@Nullable
<T> T getConfigObject(String key,
                      Class<T> aClass)

Get configuration object produced by PlanConfigurationUiPlugin

Parameters:

key -

aClass -

Returns:

configObject

Since:

3.0