com.atlassian.bamboo.plan

Interface PlanExecutionConfig

All Known Implementing Classes:

PlanExecutionConfigImpl

@Internal
public interface PlanExecutionConfig

Used to control plan execution taking care of manual stages and plan restart

Since:

3.2

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PlanExecutionConfig.PlanExecutionType Type of repeated plan execution

Method Summary

Modifier and Type	Method and Description
PlanExecutionConfig	build()
PlanExecutionConfig.PlanExecutionType	getPlanExecutionType() type of resumed plan execution
PlanResultKey	getResultToRerun() PlanResultKey of build to start again
Set<ImmutableChainStage>	getStagesToExecute()
StageIdentifier	getStartStage() Stage where plan execution should be resumed
boolean	isBranchMergePushOverride() If branch merging is enabled, if we override the push
boolean	isContinueFromFailed() Executing manual stage of unsuccessful build.
boolean	isGoingToStopAtManualStage() true if the first stage not scheduled for execution was manual
boolean	isScheduledForExecution(String name)
boolean	isStageToStopFinal()
void	setBranchMergePushOverride(boolean branchMergePushOverride)
PlanExecutionConfig	setChain(ImmutableChain chain)
PlanExecutionConfig	setChainResultSummary(ChainResultsSummary chainResultsSummary)
PlanExecutionConfig	setExecuteAllStages()
PlanExecutionConfig	setLatestManualStageForAutomaticExecution(String latestManualStageForAutomaticExecution)

Method Detail

setChain

PlanExecutionConfig setChain(ImmutableChain chain)

setChainResultSummary

PlanExecutionConfig setChainResultSummary(ChainResultsSummary chainResultsSummary)

setLatestManualStageForAutomaticExecution

PlanExecutionConfig setLatestManualStageForAutomaticExecution(@Nullable
                                                              String latestManualStageForAutomaticExecution)

setExecuteAllStages

PlanExecutionConfig setExecuteAllStages()

build

@NotNull
PlanExecutionConfig build()

isScheduledForExecution

boolean isScheduledForExecution(String name)

getResultToRerun

@NotNull
PlanResultKey getResultToRerun()

PlanResultKey of build to start again

Returns:

getStartStage

@Nullable
StageIdentifier getStartStage()

Stage where plan execution should be resumed

Returns:

null iff restarting chain that failed after all the Jobs run successfully

getStagesToExecute

Set<ImmutableChainStage> getStagesToExecute()

getPlanExecutionType

PlanExecutionConfig.PlanExecutionType getPlanExecutionType()

type of resumed plan execution

Returns:

isGoingToStopAtManualStage

boolean isGoingToStopAtManualStage()

true if the first stage not scheduled for execution was manual

Returns:

isStageToStopFinal

boolean isStageToStopFinal()

isBranchMergePushOverride

boolean isBranchMergePushOverride()

If branch merging is enabled, if we override the push

Returns:

isContinueFromFailed

boolean isContinueFromFailed()

Executing manual stage of unsuccessful build. Only possible when manual stage is also a final stage.

Returns:

setBranchMergePushOverride

void setBranchMergePushOverride(boolean branchMergePushOverride)