software.amazon.awscdk.services.stepfunctions

Class State

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.services.stepfunctions.State

All Implemented Interfaces:

IConstruct, IDependable, IChainable

Direct Known Subclasses:

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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:43.497Z")
public abstract class State
extends Construct
implements IChainable

Base class for all other state classes.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.IChainable

IChainable.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Constructor Summary

Constructors

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

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(java.lang.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 java.util.List<INextable>	filterNextables(java.util.List<? extends State> states) Return only the states that allow chaining from an array of states.
static java.util.List<State>	findReachableEndStates(State start) Find the set of end states states reachable through transitions from the given start state.
static java.util.List<State>	findReachableEndStates(State start, FindStateOptions options) Find the set of end states states reachable through transitions from the given start state.
static java.util.List<State>	findReachableStates(State start) Find the set of states reachable through transitions from the given start state.
static java.util.List<State>	findReachableStates(State start, FindStateOptions options) Find the set of states reachable through transitions from the given start state.
protected java.util.List<StateGraph>	getBranches()
protected java.lang.String	getComment()
protected State	getDefaultChoice()
abstract java.util.List<INextable>	getEndStates() Continuable states of this Chainable.
java.lang.String	getId() Descriptive identifier for this chainable.
protected java.lang.String	getInputPath()
protected StateGraph	getIteration()
protected java.lang.String	getOutputPath()
protected com.fasterxml.jackson.databind.node.ObjectNode	getParameters()
protected java.lang.String	getResultPath()
protected com.fasterxml.jackson.databind.node.ObjectNode	getResultSelector()
State	getStartState() First state of this Chainable.
java.lang.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(software.constructs.IConstruct root, java.lang.String prefix) Add a prefix to the stateId of all States found in a construct tree.
protected java.lang.Object	renderBranches() Render parallel branches in ASL JSON format.
protected java.lang.Object	renderChoices() Render the choices in ASL JSON format.
protected java.lang.Object	renderInputOutput() Render InputPath/Parameters/OutputPath in ASL JSON format.
protected java.lang.Object	renderIterator() Render map iterator in ASL JSON format.
protected java.lang.Object	renderNextEnd() Render the default next state in ASL JSON format.
protected java.lang.Object	renderResultSelector() Render ResultSelector in ASL JSON format.
protected java.lang.Object	renderRetryCatch() Render error recovery options in ASL JSON format.
protected void	setDefaultChoice(State value)
protected void	setIteration(StateGraph value)
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 java.lang.Object

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

Constructor Detail

State

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

State

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

State

protected State(software.constructs.Construct scope,
                java.lang.String id,
                StateProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

filterNextables

public static java.util.List<INextable> filterNextables(java.util.List<? extends State> states)

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

Parameters:

states - This parameter is required.

findReachableEndStates

public static java.util.List<State> findReachableEndStates(State start,
                                                           FindStateOptions options)

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

Parameters:

start - This parameter is required.

options -

findReachableEndStates

public static java.util.List<State> findReachableEndStates(State start)

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

Parameters:

start - This parameter is required.

findReachableStates

public static java.util.List<State> findReachableStates(State start,
                                                        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.

Parameters:

start - This parameter is required.

options -

findReachableStates

public static java.util.List<State> findReachableStates(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.

Parameters:

start - This parameter is required.

prefixStates

public static void prefixStates(software.constructs.IConstruct root,
                                java.lang.String prefix)

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

Parameters:

root - This parameter is required.

prefix - This parameter is required.

addBranch

protected void addBranch(StateGraph branch)

Add a paralle branch to this state.

Parameters:

branch - This parameter is required.

addChoice

protected void addChoice(Condition condition,
                         State next)

Add a choice branch to this state.

Parameters:

condition - This parameter is required.

next - This parameter is required.

addIterator

protected void addIterator(StateGraph iteration)

Add a map iterator to this state.

Parameters:

iteration - This parameter is required.

addPrefix

public void addPrefix(java.lang.String x)

Add a prefix to the stateId of this state.

Parameters:

x - This parameter is required.

bindToGraph

public void bindToGraph(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.

Parameters:

graph - This parameter is required.

makeDefault

protected void makeDefault(State def)

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

Parameters:

def - This parameter is required.

makeNext

protected void makeNext(State next)

Make the indicated state the default transition of this state.

Parameters:

next - This parameter is required.

renderBranches

protected java.lang.Object renderBranches()

Render parallel branches in ASL JSON format.

renderChoices

protected java.lang.Object renderChoices()

Render the choices in ASL JSON format.

renderInputOutput

protected java.lang.Object renderInputOutput()

Render InputPath/Parameters/OutputPath in ASL JSON format.

renderIterator

protected java.lang.Object renderIterator()

Render map iterator in ASL JSON format.

renderNextEnd

protected java.lang.Object renderNextEnd()

Render the default next state in ASL JSON format.

renderResultSelector

protected java.lang.Object renderResultSelector()

Render ResultSelector in ASL JSON format.

renderRetryCatch

protected java.lang.Object renderRetryCatch()

Render error recovery options in ASL JSON format.

toStateJson

public abstract com.fasterxml.jackson.databind.node.ObjectNode toStateJson()

Render the state as JSON.

whenBoundToGraph

protected void whenBoundToGraph(StateGraph graph)

Called whenever this state is bound to a graph.

Can be overridden by subclasses.

Parameters:

graph - This parameter is required.

getBranches

protected java.util.List<StateGraph> getBranches()

getEndStates

public abstract java.util.List<INextable> getEndStates()

Continuable states of this Chainable.

Specified by:

getEndStates in interface IChainable

getId

public java.lang.String getId()

Descriptive identifier for this chainable.

Specified by:

getId in interface IChainable

getStartState

public State getStartState()

First state of this Chainable.

Specified by:

getStartState in interface IChainable

getStateId

public java.lang.String getStateId()

Tokenized string that evaluates to the state's ID.

getComment

protected java.lang.String getComment()

getInputPath

protected java.lang.String getInputPath()

getOutputPath

protected java.lang.String getOutputPath()

getParameters

protected com.fasterxml.jackson.databind.node.ObjectNode getParameters()

getResultPath

protected java.lang.String getResultPath()

getResultSelector

protected com.fasterxml.jackson.databind.node.ObjectNode getResultSelector()

getDefaultChoice

protected State getDefaultChoice()

setDefaultChoice

protected void setDefaultChoice(State value)

getIteration

protected StateGraph getIteration()

setIteration

protected void setIteration(StateGraph value)