@Internal
public interface ChainBuildState

Manages the State of the running Chain

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class ChainBuildState.State

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`addResultVariablesFromPreviousStages(Map<String,VariableDefinitionContext> resultVariables)`	Updates build context of the jobs in with result variables collected in previous stage(s).
`long`	`getAverageDuration()`
`@NotNull BuildContext`	`getBuildContext()`	Gets the BuildContext for the Task
`@NotNull PlanResultKey`	`getPlanResultKey()`	`PlanResultKey` for the current `Chain`
`@NotNull StageState`	`getStageState()`	Returns the `StageState` that this `ChainBuildState` belongs to
`BuildState`	`getState()`
`boolean`	`isDispatched()`	Is the Task in the Dispatched state
`boolean`	`isFailed()`	Was the tasks execution a failure
`boolean`	`isFinalized()`	Is the Task in the Finalized state
`boolean`	`isSuccessful()`	Was the tasks execution successful or not?
`boolean`	`isWaiting()`	Is the Task in the Waiting state
`void`	`markAsDispatched()`	Sets the State to `ChainBuildState.State.DISPATCHED`
`void`	`markAsFinalized(BuildState buildState)`	Sets the State to `ChainBuildState.State.FINALIZED`
`void`	`setPublishedChainArtifactsInfo(@NotNull com.google.common.collect.Multimap<String,Artifact> publishedChainArtifacts)`	Updates build context of the jobs with artifacts published in previous stage(s).

- Method Detail
  - getPlanResultKey
```
@NotNull
@NotNull PlanResultKey getPlanResultKey()
```
    PlanResultKey for the current Chain
    
    Returns:
    
    planResultKey
  - getStageState
```
@NotNull
@NotNull StageState getStageState()
```
    Returns the StageState that this ChainBuildState belongs to
    
    Returns:
    
    stageState
  - markAsDispatched
```
void markAsDispatched()
```
    Sets the State to ChainBuildState.State.DISPATCHED
  - markAsFinalized
```
void markAsFinalized(BuildState buildState)
```
    Sets the State to ChainBuildState.State.FINALIZED
    
    Parameters:
    
    buildState -
  - getState
```
BuildState getState()
```
    Returns:
    
    the current BuildState for this Job.
  - isWaiting
```
boolean isWaiting()
```
    Is the Task in the Waiting state
    
    Returns:
  - isDispatched
```
boolean isDispatched()
```
    Is the Task in the Dispatched state
    
    Returns:
  - isFinalized
```
boolean isFinalized()
```
    Is the Task in the Finalized state
    
    Returns:
  - isSuccessful
```
boolean isSuccessful()
```
    Was the tasks execution successful or not?
    
    Returns:
    
    success
  - isFailed
```
boolean isFailed()
```
    Was the tasks execution a failure
    
    Returns:
    
    failure
  - getBuildContext
```
@NotNull
@NotNull BuildContext getBuildContext()
```
    Gets the BuildContext for the Task
    
    Returns:
    
    buildContext
  - getAverageDuration
```
long getAverageDuration()
```
    Returns:
    
    averageDuration of the Job
  - addResultVariablesFromPreviousStages
```
void addResultVariablesFromPreviousStages(Map<String,VariableDefinitionContext> resultVariables)
```
    Updates build context of the jobs in with result variables collected in previous stage(s).
    
    Parameters:
    
    resultVariables -
  - setPublishedChainArtifactsInfo
```
void setPublishedChainArtifactsInfo(@NotNull
                                    @NotNull com.google.common.collect.Multimap<String,Artifact> publishedChainArtifacts)
```
    Updates build context of the jobs with artifacts published in previous stage(s).
    
    Parameters:
    
    publishedChainArtifacts -

Interface ChainBuildState

Nested Class Summary

Method Summary

Method Detail

getPlanResultKey

getStageState

markAsDispatched

markAsFinalized

getState

isWaiting

isDispatched

isFinalized

isSuccessful

isFailed

getBuildContext

getAverageDuration

addResultVariablesFromPreviousStages

setPublishedChainArtifactsInfo