software.amazon.awscdk.services.stepfunctions

Class State

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.services.stepfunctions.State

All Implemented Interfaces:

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

Direct Known Subclasses:

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

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:01:38.429Z")
 @Stability(value=Experimental)
public abstract class State
extends software.constructs.Construct
implements IChainable

(experimental) Base class for all other state classes.

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IChainable.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Constructor Summary

Constructors

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

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, 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
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @NotNull
                                               StateProps props)

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<? extends State> states)

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

Parameters:

states - This parameter is required.

findReachableEndStates

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

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

Parameters:

start - This parameter is required.

options -

findReachableEndStates

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

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

Parameters:

start - This parameter is required.

findReachableStates

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

(experimental) 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

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

(experimental) 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

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

(experimental) 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

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

(experimental) Add a paralle branch to this state.

Parameters:

branch - This parameter is required.

addChoice

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

(experimental) Add a choice branch to this state.

Parameters:

condition - This parameter is required.

next - This parameter is required.

addIterator

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

(experimental) Add a map iterator to this state.

Parameters:

iteration - This parameter is required.

addPrefix

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

(experimental) Add a prefix to the stateId of this state.

Parameters:

x - This parameter is required.

bindToGraph

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

(experimental) 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

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

(experimental) Make the indicated state the default choice transition of this state.

Parameters:

def - This parameter is required.

makeNext

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

(experimental) Make the indicated state the default transition of this state.

Parameters:

next - This parameter is required.

renderBranches

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

(experimental) Render parallel branches in ASL JSON format.

renderChoices

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

(experimental) Render the choices in ASL JSON format.

renderInputOutput

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

(experimental) Render InputPath/Parameters/OutputPath in ASL JSON format.

renderIterator

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

(experimental) Render map iterator in ASL JSON format.

renderNextEnd

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

(experimental) Render the default next state in ASL JSON format.

renderResultSelector

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

(experimental) Render ResultSelector in ASL JSON format.

renderRetryCatch

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

(experimental) Render error recovery options in ASL JSON format.

toStateJson

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

(experimental) Render the state as JSON.

validateState

@Stability(value=Experimental)
 @NotNull
protected List<String> validateState()

(experimental) Allows the state to validate itself.

whenBoundToGraph

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

(experimental) Called whenever this state is bound to a graph.

Can be overridden by subclasses.

Parameters:

graph - This parameter is required.

getBranches

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

getEndStates

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

(experimental) Continuable states of this Chainable.

Specified by:

getEndStates in interface IChainable

getId

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

(experimental) Descriptive identifier for this chainable.

Specified by:

getId in interface IChainable

getStartState

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

(experimental) First state of this Chainable.

Specified by:

getStartState in interface IChainable

getStateId

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

(experimental) Tokenized string that evaluates to the state's ID.

getComment

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

getInputPath

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

getOutputPath

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

getParameters

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

getResultPath

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

getResultSelector

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

getDefaultChoice

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

setDefaultChoice

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

getIteration

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

setIteration

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