@PublicApi public interface ChainExecution extends ExecutionStatus
Chain
Modifier and Type | Method and 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
|
getAverageDuration, getBuildChanges, getBuildIdentifier, getElapsedTime, getProgressBar, getQueueTime, getStartTime
@NotNull @NotNull String getName()
@NotNull @NotNull PlanResultKey getPlanResultKey()
@NotNull @NotNull List<StageExecution> getStages()
boolean isCompleted()
boolean isSuccessful()
boolean isFailed()
boolean isStopping()
boolean isStopRequested()
Chain
has been requested to stop execution@NotNull @NotNull ExecutionContext getExecutionContext()
ChainExecution
@Nullable @Nullable StageExecution getCurrentStage()
StageExecution
@NotNull @NotNull TriggerReason getTriggerReason()
TriggerReason
for the current ChainExecution
getTriggerReason
in interface ExecutionStatus
@Nullable <T> T getConfigObject(String key, Class<T> aClass)
PlanConfigurationUiPlugin
key
- aClass
- Copyright © 2022 Atlassian Software Systems Pty Ltd. All rights reserved.