software.amazon.awscdk.services.stepfunctions

Class State

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.services.stepfunctions.State

All Implemented Interfaces:

IDependable, IChainable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

Direct Known Subclasses:

Choice, CustomState, Fail, Map, Parallel, Pass, Succeed, Task, Wait

@Generated(value="jsii-pacmak/1.5.0 (build 46538f8)",
           date="2020-05-15T23:35:58.924Z")
 @Stability(value=Experimental)
public abstract class State
extends Construct
implements IChainable

Base class for all other state classes.

EXPERIMENTAL

Nested Class Summary

Nested classes/interfaces inherited from class software.constructs.Construct

software.constructs.Construct.Builder

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	State(Construct scope, String id, StateProps props) EXPERIMENTAL
protected	State(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	State(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected void	addBranch(StateGraph branch) Add a paralle branch to this state.
protected void	addChoice(Condition condition, State next) Add a choice branch to this state.
protected void	addIterator(StateGraph iteration) Add a map iterator to this state.
void	addPrefix(String x) Add a prefix to the stateId of this state.
void	bindToGraph(StateGraph graph) Register this state as part of the given graph.
static List<INextable>	filterNextables(List<State> states) Return only the states that allow chaining from an array of states.
static List<State>	findReachableEndStates(State start) Find the set of end states states reachable through transitions from the given start state.
static List<State>	findReachableEndStates(State start, FindStateOptions options) Find the set of end states states reachable through transitions from the given start state.
static List<State>	findReachableStates(State start) Find the set of states reachable through transitions from the given start state.
static List<State>	findReachableStates(State start, FindStateOptions options) Find the set of states reachable through transitions from the given start state.
protected List<StateGraph>	getBranches() EXPERIMENTAL
protected String	getComment() EXPERIMENTAL
protected State	getDefaultChoice() EXPERIMENTAL
abstract List<INextable>	getEndStates() Continuable states of this Chainable.
String	getId() Descriptive identifier for this chainable.
protected String	getInputPath() EXPERIMENTAL
protected StateGraph	getIteration() EXPERIMENTAL
protected String	getOutputPath() EXPERIMENTAL
protected com.fasterxml.jackson.databind.node.ObjectNode	getParameters() EXPERIMENTAL
protected String	getResultPath() EXPERIMENTAL
State	getStartState() First state of this Chainable.
String	getStateId() Tokenized string that evaluates to the state's ID.
protected void	makeDefault(State def) Make the indicated state the default choice transition of this state.
protected void	makeNext(State next) Make the indicated state the default transition of this state.
static void	prefixStates(IConstruct root, String prefix) Add a prefix to the stateId of all States found in a construct tree.
protected Object	renderBranches() Render parallel branches in ASL JSON format.
protected Object	renderChoices() Render the choices in ASL JSON format.
protected Object	renderInputOutput() Render InputPath/Parameters/OutputPath in ASL JSON format.
protected Object	renderIterator() Render map iterator in ASL JSON format.
protected Object	renderNextEnd() Render the default next state in ASL JSON format.
protected Object	renderRetryCatch() Render error recovery options in ASL JSON format.
protected void	setDefaultChoice(State value) EXPERIMENTAL
protected void	setIteration(StateGraph value) EXPERIMENTAL
abstract com.fasterxml.jackson.databind.node.ObjectNode	toStateJson() Render the state as JSON.
protected void	whenBoundToGraph(StateGraph graph) Called whenever this state is bound to a graph.

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.constructs.Construct

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

State

protected State(software.amazon.jsii.JsiiObjectRef objRef)

State

protected State(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

State

@Stability(value=Experimental)
protected State(@NotNull
                                               Construct scope,
                                               @NotNull
                                               String id,
                                               @NotNull
                                               StateProps props)

EXPERIMENTAL

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

filterNextables

@Stability(value=Experimental)
 @NotNull
public static List<INextable> filterNextables(@NotNull
                                                                                       List<State> states)

Return only the states that allow chaining from an array of states.

EXPERIMENTAL

Parameters:

states - This parameter is required.

findReachableEndStates

@Stability(value=Experimental)
 @NotNull
public static List<State> findReachableEndStates(@NotNull
                                                                                          State start,
                                                                                          @Nullable
                                                                                          FindStateOptions options)

Find the set of end states states reachable through transitions from the given start state.

EXPERIMENTAL

Parameters:

start - This parameter is required.

options -

findReachableEndStates

@Stability(value=Experimental)
 @NotNull
public static List<State> findReachableEndStates(@NotNull
                                                                                          State start)

Find the set of end states states reachable through transitions from the given start state.

EXPERIMENTAL

Parameters:

start - This parameter is required.

findReachableStates

@Stability(value=Experimental)
 @NotNull
public static List<State> findReachableStates(@NotNull
                                                                                       State start,
                                                                                       @Nullable
                                                                                       FindStateOptions options)

Find the set of states reachable through transitions from the given start state.

This does not retrieve states from within sub-graphs, such as states within a Parallel state's branch.

EXPERIMENTAL

Parameters:

start - This parameter is required.

options -

findReachableStates

@Stability(value=Experimental)
 @NotNull
public static List<State> findReachableStates(@NotNull
                                                                                       State start)

Find the set of states reachable through transitions from the given start state.

This does not retrieve states from within sub-graphs, such as states within a Parallel state's branch.

EXPERIMENTAL

Parameters:

start - This parameter is required.

prefixStates

@Stability(value=Experimental)
public static void prefixStates(@NotNull
                                                               IConstruct root,
                                                               @NotNull
                                                               String prefix)

Add a prefix to the stateId of all States found in a construct tree.

EXPERIMENTAL

Parameters:

root - This parameter is required.

prefix - This parameter is required.

addBranch

@Stability(value=Experimental)
protected void addBranch(@NotNull
                                                        StateGraph branch)

Add a paralle branch to this state.

EXPERIMENTAL

Parameters:

branch - This parameter is required.

addChoice

@Stability(value=Experimental)
protected void addChoice(@NotNull
                                                        Condition condition,
                                                        @NotNull
                                                        State next)

Add a choice branch to this state.

EXPERIMENTAL

Parameters:

condition - This parameter is required.

next - This parameter is required.

addIterator

@Stability(value=Experimental)
protected void addIterator(@NotNull
                                                          StateGraph iteration)

Add a map iterator to this state.

EXPERIMENTAL

Parameters:

iteration - This parameter is required.

addPrefix

@Stability(value=Experimental)
public void addPrefix(@NotNull
                                                     String x)

Add a prefix to the stateId of this state.

EXPERIMENTAL

Parameters:

x - This parameter is required.

bindToGraph

@Stability(value=Experimental)
public void bindToGraph(@NotNull
                                                       StateGraph graph)

Register this state as part of the given graph.

Don't call this. It will be called automatically when you work with states normally.

EXPERIMENTAL

Parameters:

graph - This parameter is required.

makeDefault

@Stability(value=Experimental)
protected void makeDefault(@NotNull
                                                          State def)

Make the indicated state the default choice transition of this state.

EXPERIMENTAL

Parameters:

def - This parameter is required.

makeNext

@Stability(value=Experimental)
protected void makeNext(@NotNull
                                                       State next)

Make the indicated state the default transition of this state.

EXPERIMENTAL

Parameters:

next - This parameter is required.

renderBranches

@Stability(value=Experimental)
 @NotNull
protected Object renderBranches()

Render parallel branches in ASL JSON format.

EXPERIMENTAL

renderChoices

@Stability(value=Experimental)
 @NotNull
protected Object renderChoices()

Render the choices in ASL JSON format.

EXPERIMENTAL

renderInputOutput

@Stability(value=Experimental)
 @NotNull
protected Object renderInputOutput()

Render InputPath/Parameters/OutputPath in ASL JSON format.

EXPERIMENTAL

renderIterator

@Stability(value=Experimental)
 @NotNull
protected Object renderIterator()

Render map iterator in ASL JSON format.

EXPERIMENTAL

renderNextEnd

@Stability(value=Experimental)
 @NotNull
protected Object renderNextEnd()

Render the default next state in ASL JSON format.

EXPERIMENTAL

renderRetryCatch

@Stability(value=Experimental)
 @NotNull
protected Object renderRetryCatch()

Render error recovery options in ASL JSON format.

EXPERIMENTAL

toStateJson

@Stability(value=Experimental)
 @NotNull
public abstract com.fasterxml.jackson.databind.node.ObjectNode toStateJson()

Render the state as JSON.

EXPERIMENTAL

whenBoundToGraph

@Stability(value=Experimental)
protected void whenBoundToGraph(@NotNull
                                                               StateGraph graph)

Called whenever this state is bound to a graph.

Can be overridden by subclasses.

EXPERIMENTAL

Parameters:

graph - This parameter is required.

getBranches

@Stability(value=Experimental)
 @NotNull
protected List<StateGraph> getBranches()

EXPERIMENTAL

getEndStates

@Stability(value=Experimental)
 @NotNull
public abstract List<INextable> getEndStates()

Continuable states of this Chainable.

EXPERIMENTAL

Specified by:

getEndStates in interface IChainable

getId

@Stability(value=Experimental)
 @NotNull
public String getId()

Descriptive identifier for this chainable.

EXPERIMENTAL

Specified by:

getId in interface IChainable

getStartState

@Stability(value=Experimental)
 @NotNull
public State getStartState()

First state of this Chainable.

EXPERIMENTAL

Specified by:

getStartState in interface IChainable

getStateId

@Stability(value=Experimental)
 @NotNull
public String getStateId()

Tokenized string that evaluates to the state's ID.

EXPERIMENTAL

getComment

@Stability(value=Experimental)
 @Nullable
protected String getComment()

EXPERIMENTAL

getInputPath

@Stability(value=Experimental)
 @Nullable
protected String getInputPath()

EXPERIMENTAL

getOutputPath

@Stability(value=Experimental)
 @Nullable
protected String getOutputPath()

EXPERIMENTAL

getParameters

@Stability(value=Experimental)
 @Nullable
protected com.fasterxml.jackson.databind.node.ObjectNode getParameters()

EXPERIMENTAL

getResultPath

@Stability(value=Experimental)
 @Nullable
protected String getResultPath()

EXPERIMENTAL

getDefaultChoice

@Stability(value=Experimental)
 @Nullable
protected State getDefaultChoice()

EXPERIMENTAL

setDefaultChoice

@Stability(value=Experimental)
protected void setDefaultChoice(@Nullable
                                                               State value)

EXPERIMENTAL

getIteration

@Stability(value=Experimental)
 @Nullable
protected StateGraph getIteration()

EXPERIMENTAL

setIteration

@Stability(value=Experimental)
protected void setIteration(@Nullable
                                                           StateGraph value)

EXPERIMENTAL