@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:43.497Z") public abstract class State extends Construct implements IChainable
IChainable.Jsii$Default
IConstruct.Jsii$Default
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) |
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.
|
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
protected State(software.amazon.jsii.JsiiObjectRef objRef)
protected State(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected State(software.constructs.Construct scope, java.lang.String id, StateProps props)
scope
- This parameter is required.id
- This parameter is required.props
- This parameter is required.public static java.util.List<INextable> filterNextables(java.util.List<? extends State> states)
states
- This parameter is required.public static java.util.List<State> findReachableEndStates(State start, FindStateOptions options)
start
- This parameter is required.options
- public static java.util.List<State> findReachableEndStates(State start)
start
- This parameter is required.public static java.util.List<State> findReachableStates(State start, FindStateOptions options)
This does not retrieve states from within sub-graphs, such as states within a Parallel state's branch.
start
- This parameter is required.options
- public static java.util.List<State> findReachableStates(State start)
This does not retrieve states from within sub-graphs, such as states within a Parallel state's branch.
start
- This parameter is required.public static void prefixStates(software.constructs.IConstruct root, java.lang.String prefix)
root
- This parameter is required.prefix
- This parameter is required.protected void addBranch(StateGraph branch)
branch
- This parameter is required.protected void addChoice(Condition condition, State next)
condition
- This parameter is required.next
- This parameter is required.protected void addIterator(StateGraph iteration)
iteration
- This parameter is required.public void addPrefix(java.lang.String x)
x
- This parameter is required.public void bindToGraph(StateGraph graph)
Don't call this. It will be called automatically when you work with states normally.
graph
- This parameter is required.protected void makeDefault(State def)
def
- This parameter is required.protected void makeNext(State next)
next
- This parameter is required.protected java.lang.Object renderBranches()
protected java.lang.Object renderChoices()
protected java.lang.Object renderInputOutput()
protected java.lang.Object renderIterator()
protected java.lang.Object renderNextEnd()
protected java.lang.Object renderResultSelector()
protected java.lang.Object renderRetryCatch()
public abstract com.fasterxml.jackson.databind.node.ObjectNode toStateJson()
protected void whenBoundToGraph(StateGraph graph)
Can be overridden by subclasses.
graph
- This parameter is required.protected java.util.List<StateGraph> getBranches()
public abstract java.util.List<INextable> getEndStates()
getEndStates
in interface IChainable
public java.lang.String getId()
getId
in interface IChainable
public State getStartState()
getStartState
in interface IChainable
public java.lang.String getStateId()
protected java.lang.String getComment()
protected java.lang.String getInputPath()
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()
protected State getDefaultChoice()
protected void setDefaultChoice(State value)
protected StateGraph getIteration()
protected void setIteration(StateGraph value)