software.amazon.awscdk.services.stepfunctions

Class Parallel

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.services.stepfunctions.State

software.amazon.awscdk.services.stepfunctions.Parallel

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.54.0 (build b1b977a)",
           date="2022-02-19T00:19:34.320Z")
 @Stability(value=Stable)
public class Parallel
extends State
implements INextable

Define a Parallel state in the state machine.

A Parallel state can be used to run one or more state machines at the same time.

The Result of a Parallel state is an array of the results of its substatemachines.

Example:

 import software.amazon.awscdk.core.Stack;
 import software.constructs.Construct;
 import software.amazon.awscdk.services.stepfunctions.*;
 public class MyJobProps {
     private String jobFlavor;
     public String getJobFlavor() {
         return this.jobFlavor;
     }
     public MyJobProps jobFlavor(String jobFlavor) {
         this.jobFlavor = jobFlavor;
         return this;
     }
 }
 public class MyJob extends StateMachineFragment {
     public final State startState;
     public final INextable[] endStates;
     public MyJob(Construct parent, String id, MyJobProps props) {
         super(parent, id);
         Choice choice = new Choice(this, "Choice").when(Condition.stringEquals("$.branch", "left"), new Pass(this, "Left Branch")).when(Condition.stringEquals("$.branch", "right"), new Pass(this, "Right Branch"));
         // ...
         this.startState = choice;
         this.endStates = choice.afterwards().getEndStates();
     }
 }
 public class MyStack extends Stack {
     public MyStack(Construct scope, String id) {
         super(scope, id);
         // Do 3 different variants of MyJob in parallel
         Parallel parallel = new Parallel(this, "All jobs").branch(new MyJob(this, "Quick", new MyJobProps().jobFlavor("quick")).prefixStates()).branch(new MyJob(this, "Medium", new MyJobProps().jobFlavor("medium")).prefixStates()).branch(new MyJob(this, "Slow", new MyJobProps().jobFlavor("slow")).prefixStates());
         StateMachine.Builder.create(this, "MyStateMachine")
                 .definition(parallel)
                 .build();
     }
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Parallel.Builder A fluent builder for Parallel.

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.INextable

INextable.Jsii$Default, INextable.Jsii$Proxy

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

Method Summary

Modifier and Type	Method and Description
Parallel	addCatch(IChainable handler) Add a recovery handler for this state.
Parallel	addCatch(IChainable handler, CatchProps props) Add a recovery handler for this state.
Parallel	addRetry() Add retry configuration for this state.
Parallel	addRetry(RetryProps props) Add retry configuration for this state.
void	bindToGraph(StateGraph graph) Overwrites State.bindToGraph.
Parallel	branch(IChainable... branches) Define one or more branches to run in parallel.
List<INextable>	getEndStates() Continuable states of this Chainable.
Chain	next(IChainable next) Continue normal execution with the given state.
com.fasterxml.jackson.databind.node.ObjectNode	toStateJson() Return the Amazon States Language object for this state.
protected List<String>	validate() Validate this state.

Methods inherited from class software.amazon.awscdk.services.stepfunctions.State

addBranch, addChoice, addIterator, addPrefix, filterNextables, findReachableEndStates, findReachableEndStates, findReachableStates, findReachableStates, getBranches, getComment, getDefaultChoice, getId, getInputPath, getIteration, getOutputPath, getParameters, getResultPath, getResultSelector, getStartState, getStateId, makeDefault, makeNext, prefixStates, renderBranches, renderChoices, renderInputOutput, renderIterator, renderNextEnd, renderResultSelector, renderRetryCatch, setDefaultChoice, setIteration, whenBoundToGraph

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

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

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, 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

Parallel

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

Parallel

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

Parallel

@Stability(value=Stable)
public Parallel(@NotNull
                                         software.constructs.Construct scope,
                                         @NotNull
                                         String id,
                                         @Nullable
                                         ParallelProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

Parallel

@Stability(value=Stable)
public Parallel(@NotNull
                                         software.constructs.Construct scope,
                                         @NotNull
                                         String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

addCatch

@Stability(value=Stable)
 @NotNull
public Parallel addCatch(@NotNull
                                                            IChainable handler,
                                                            @Nullable
                                                            CatchProps props)

Add a recovery handler for this state.

When a particular error occurs, execution will continue at the error handler instead of failing the state machine execution.

Parameters:

handler - This parameter is required.

props -

addCatch

@Stability(value=Stable)
 @NotNull
public Parallel addCatch(@NotNull
                                                            IChainable handler)

Add a recovery handler for this state.

When a particular error occurs, execution will continue at the error handler instead of failing the state machine execution.

Parameters:

handler - This parameter is required.

addRetry

@Stability(value=Stable)
 @NotNull
public Parallel addRetry(@Nullable
                                                            RetryProps props)

Add retry configuration for this state.

This controls if and how the execution will be retried if a particular error occurs.

Parameters:

props -

addRetry

@Stability(value=Stable)
 @NotNull
public Parallel addRetry()

Add retry configuration for this state.

This controls if and how the execution will be retried if a particular error occurs.

bindToGraph

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

Overwrites State.bindToGraph. Adds branches to the Parallel state here so that any necessary prefixes are appended first.

Overrides:

bindToGraph in class State

Parameters:

graph - This parameter is required.

branch

@Stability(value=Stable)
 @NotNull
public Parallel branch(@NotNull
                                                          IChainable... branches)

Define one or more branches to run in parallel.

Parameters:

branches - This parameter is required.

next

@Stability(value=Stable)
 @NotNull
public Chain next(@NotNull
                                                     IChainable next)

Continue normal execution with the given state.

Specified by:

next in interface INextable

Parameters:

next - This parameter is required.

Returns:

The chain of states built up

toStateJson

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

Return the Amazon States Language object for this state.

Specified by:

toStateJson in class State

validate

@Stability(value=Stable)
 @NotNull
protected List<String> validate()

Validate this state.

Overrides:

validate in class Construct

getEndStates

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

Continuable states of this Chainable.

Specified by:

getEndStates in interface IChainable

Specified by:

getEndStates in class State