Package com.atlassian.bamboo.chains
Interface BuildExecution
-
- All Superinterfaces:
ExecutionStatus
@PublicApi public interface BuildExecution extends ExecutionStatus
Represents a runningJob
executing within aChainStage
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description @NotNull BuildContext
getBuildContext()
TheBuildContext
of build process represented by this object.@NotNull BuildState
getBuildState()
Returns the BuildState (success or failure)<T> T
getConfigObject(String key, Class<T> aClass)
Get configuration object produced byPlanConfigurationUiPlugin
@NotNull PlanResultKey
getPlanResultKey()
@NotNull StageExecution
getStageExecution()
Returns theStageExecution
that theBuildExecution
is a component ofboolean
isBuilding()
Returns true if the build is currently executingboolean
isCompleted()
Returns true if the build has completedboolean
isSuccessful()
If the Build is successful or not-
Methods inherited from interface com.atlassian.bamboo.plan.ExecutionStatus
getAverageDuration, getBuildChanges, getBuildIdentifier, getElapsedTime, getProgressBar, getQueueTime, getStartTime, getTriggerReason
-
-
-
-
Method Detail
-
getPlanResultKey
@NotNull @NotNull PlanResultKey getPlanResultKey()
- Returns:
- resultKey for
Job
andBuildResultsSummary
-
isBuilding
boolean isBuilding()
Returns true if the build is currently executing- Returns:
- building
-
isCompleted
boolean isCompleted()
Returns true if the build has completed- Returns:
- completed
-
isSuccessful
boolean isSuccessful()
If the Build is successful or not- Returns:
- successful
-
getBuildState
@NotNull @NotNull BuildState getBuildState()
Returns the BuildState (success or failure)- Returns:
- buildState
-
getStageExecution
@NotNull @NotNull StageExecution getStageExecution()
Returns theStageExecution
that theBuildExecution
is a component of- Returns:
- stageExection
-
getBuildContext
@NotNull @NotNull BuildContext getBuildContext()
TheBuildContext
of build process represented by this object.- Returns:
- buildContext
-
getConfigObject
@Nullable <T> T getConfigObject(String key, Class<T> aClass)
Get configuration object produced byPlanConfigurationUiPlugin
- Parameters:
key
-aClass
-- Returns:
- configObject
- Since:
- 3.0
-
-