Package 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, MapBase, Parallel, Pass, Succeed, TaskStateBase, Wait

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-25T14:21:24.354Z")
@Stability(Stable)
public abstract class State
extends software.constructs.Construct
implements IChainable

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	Description
protected	State(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	State(software.amazon.jsii.JsiiObjectRef objRef)
protected	State(software.constructs.Construct scope, String id, StateProps props)

Method Summary

Modifier and Type	Method	Description
protected void	addBranch(StateGraph branch)	Add a parallel branch to this state.
protected void	addChoice(Condition condition, State next)	Add a choice branch to this state.
protected void	addChoice(Condition condition, State next, ChoiceTransitionOptions options)	Add a choice branch to this state.
protected void	addItemProcessor(StateGraph processor)	Add a item processor to this state.
protected void	addItemProcessor(StateGraph processor, ProcessorConfig config)	Add a item processor 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<? extends 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()
protected String	getComment()
protected State	getDefaultChoice()
abstract List<INextable>	getEndStates()	Continuable states of this Chainable.
String	getId()	Descriptive identifier for this chainable.
protected String	getInputPath()
protected StateGraph	getIteration()
protected String	getOutputPath()
protected com.fasterxml.jackson.databind.node.ObjectNode	getParameters()
protected StateGraph	getProcessor()
protected ProcessorConfig	getProcessorConfig()
protected ProcessorMode	getProcessorMode()
protected String	getResultPath()
protected com.fasterxml.jackson.databind.node.ObjectNode	getResultSelector()
State	getStartState()	First state of this Chainable.
String	getStateId()	Tokenized string that evaluates to the state's ID.
protected String	getStateName()
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, 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	renderItemProcessor()	Render ItemProcessor 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	renderResultSelector()	Render ResultSelector in ASL JSON format.
protected Object	renderRetryCatch()	Render error recovery options in ASL JSON format.
protected void	setDefaultChoice(State value)
protected void	setIteration(StateGraph value)
protected void	setProcessor(StateGraph value)
protected void	setProcessorConfig(ProcessorConfig value)
protected void	setProcessorMode(ProcessorMode value)
abstract com.fasterxml.jackson.databind.node.ObjectNode	toStateJson()	Render the state as JSON.
protected List<String>	validateState()	Allows the state to validate itself.
protected void	whenBoundToGraph(StateGraph graph)	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 Details

State

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

State

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

State

@Stability(Stable)
protected State(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 StateProps props)

Parameters:

scope - This parameter is required.

id - Descriptive identifier for this chainable. This parameter is required.

props - This parameter is required.

Method Details

filterNextables

@Stability(Stable)
@NotNull
public static List<INextable> filterNextables(@NotNull
 List<? extends State> states)

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

Parameters:

states - This parameter is required.

findReachableEndStates

@Stability(Stable)
@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.

Parameters:

start - This parameter is required.

options -

findReachableEndStates

@Stability(Stable)
@NotNull
public static List<State> findReachableEndStates(@NotNull
 State start)

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

Parameters:

start - This parameter is required.

findReachableStates

@Stability(Stable)
@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.

Parameters:

start - This parameter is required.

options -

findReachableStates

@Stability(Stable)
@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.

Parameters:

start - This parameter is required.

prefixStates

@Stability(Stable)
public static void prefixStates(@NotNull
 software.constructs.IConstruct root,
 @NotNull
 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

@Stability(Stable)
protected void addBranch(@NotNull
 StateGraph branch)

Add a parallel branch to this state.

Parameters:

branch - This parameter is required.

addChoice

@Stability(Stable)
protected void addChoice(@NotNull
 Condition condition,
 @NotNull
 State next,
 @Nullable
 ChoiceTransitionOptions options)

Add a choice branch to this state.

Parameters:

condition - This parameter is required.

next - This parameter is required.

options -

addChoice

@Stability(Stable)
protected void addChoice(@NotNull
 Condition condition,
 @NotNull
 State next)

Add a choice branch to this state.

Parameters:

condition - This parameter is required.

next - This parameter is required.

addItemProcessor

@Stability(Stable)
protected void addItemProcessor(@NotNull
 StateGraph processor,
 @Nullable
 ProcessorConfig config)

Add a item processor to this state.

Parameters:

processor - This parameter is required.

config -

addItemProcessor

@Stability(Stable)
protected void addItemProcessor(@NotNull
 StateGraph processor)

Add a item processor to this state.

Parameters:

processor - This parameter is required.

addIterator

@Stability(Stable)
protected void addIterator(@NotNull
 StateGraph iteration)

Add a map iterator to this state.

Parameters:

iteration - This parameter is required.

addPrefix

@Stability(Stable)
public void addPrefix(@NotNull
 String x)

Add a prefix to the stateId of this state.

Parameters:

x - This parameter is required.

bindToGraph

@Stability(Stable)
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.

Parameters:

graph - This parameter is required.

makeDefault

@Stability(Stable)
protected void makeDefault(@NotNull
 State def)

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

Parameters:

def - This parameter is required.

makeNext

@Stability(Stable)
protected void makeNext(@NotNull
 State next)

Make the indicated state the default transition of this state.

Parameters:

next - This parameter is required.

renderBranches

@Stability(Stable)
@NotNull
protected Object renderBranches()

Render parallel branches in ASL JSON format.

renderChoices

@Stability(Stable)
@NotNull
protected Object renderChoices()

Render the choices in ASL JSON format.

renderInputOutput

@Stability(Stable)
@NotNull
protected Object renderInputOutput()

Render InputPath/Parameters/OutputPath in ASL JSON format.

renderItemProcessor

@Stability(Stable)
@NotNull
protected Object renderItemProcessor()

Render ItemProcessor in ASL JSON format.

renderIterator

@Stability(Stable)
@NotNull
protected Object renderIterator()

Render map iterator in ASL JSON format.

renderNextEnd

@Stability(Stable)
@NotNull
protected Object renderNextEnd()

Render the default next state in ASL JSON format.

renderResultSelector

@Stability(Stable)
@NotNull
protected Object renderResultSelector()

Render ResultSelector in ASL JSON format.

renderRetryCatch

@Stability(Stable)
@NotNull
protected Object renderRetryCatch()

Render error recovery options in ASL JSON format.

toStateJson

@Stability(Stable)
@NotNull
public abstract com.fasterxml.jackson.databind.node.ObjectNode toStateJson()

Render the state as JSON.

validateState

@Stability(Stable)
@NotNull
protected List<String> validateState()

Allows the state to validate itself.

whenBoundToGraph

@Stability(Stable)
protected void whenBoundToGraph(@NotNull
 StateGraph graph)

Called whenever this state is bound to a graph.

Can be overridden by subclasses.

Parameters:

graph - This parameter is required.

getBranches

@Stability(Stable)
@NotNull
protected List<StateGraph> getBranches()

getEndStates

@Stability(Stable)
@NotNull
public abstract List<INextable> getEndStates()

Continuable states of this Chainable.

Specified by:

getEndStates in interface IChainable

getId

@Stability(Stable)
@NotNull
public String getId()

Descriptive identifier for this chainable.

Specified by:

getId in interface IChainable

getStartState

@Stability(Stable)
@NotNull
public State getStartState()

First state of this Chainable.

Specified by:

getStartState in interface IChainable

getStateId

@Stability(Stable)
@NotNull
public String getStateId()

Tokenized string that evaluates to the state's ID.

getComment

@Stability(Stable)
@Nullable
protected String getComment()

getInputPath

@Stability(Stable)
@Nullable
protected String getInputPath()

getOutputPath

@Stability(Stable)
@Nullable
protected String getOutputPath()

getParameters

@Stability(Stable)
@Nullable
protected com.fasterxml.jackson.databind.node.ObjectNode getParameters()

getResultPath

@Stability(Stable)
@Nullable
protected String getResultPath()

getResultSelector

@Stability(Stable)
@Nullable
protected com.fasterxml.jackson.databind.node.ObjectNode getResultSelector()

getStateName

@Stability(Stable)
@Nullable
protected String getStateName()

getDefaultChoice

@Stability(Stable)
@Nullable
protected State getDefaultChoice()

setDefaultChoice

@Stability(Stable)
protected void setDefaultChoice(@Nullable
 State value)

getIteration

@Stability(Stable)
@Nullable
protected StateGraph getIteration()

setIteration

@Stability(Stable)
protected void setIteration(@Nullable
 StateGraph value)

getProcessor

@Stability(Stable)
@Nullable
protected StateGraph getProcessor()

setProcessor

@Stability(Stable)
protected void setProcessor(@Nullable
 StateGraph value)

getProcessorConfig

@Stability(Stable)
@Nullable
protected ProcessorConfig getProcessorConfig()

setProcessorConfig

@Stability(Stable)
protected void setProcessorConfig(@Nullable
 ProcessorConfig value)

getProcessorMode

@Stability(Stable)
@Nullable
protected ProcessorMode getProcessorMode()

setProcessorMode

@Stability(Stable)
protected void setProcessorMode(@Nullable
 ProcessorMode value)