com.amazonaws.services.stepfunctions.builder.states

Class ParallelState.Builder

java.lang.Object

com.amazonaws.services.stepfunctions.builder.states.ParallelState.Builder

All Implemented Interfaces:

Buildable<State>, InputOutputPathBuilder<ParallelState.Builder>, InputOutputResultPathBuilder<ParallelState.Builder>, ParametersBuilder<ParallelState.Builder>, ResultPathBuilder<ParallelState.Builder>, State.Builder

Enclosing class:

ParallelState

public static final class ParallelState.Builder
extends Object
implements InputOutputResultPathBuilder<ParallelState.Builder>, ParametersBuilder<ParallelState.Builder>

Builder for a ParallelState.

Nested Class Summary

Nested classes/interfaces inherited from interface com.amazonaws.services.stepfunctions.builder.internal.Buildable

Buildable.Utils

Method Summary

Modifier and Type	Method and Description
ParallelState.Builder	branch(Branch.Builder branchBuilder) REQUIRED.
ParallelState.Builder	branches(Branch.Builder... branchBuilders) REQUIRED.
ParallelState	build()
ParallelState.Builder	catcher(Catcher.Builder catcherBuilder) OPTIONAL.
ParallelState.Builder	catchers(Catcher.Builder... catcherBuilders) OPTIONAL.
ParallelState.Builder	comment(String comment) OPTIONAL.
ParallelState.Builder	inputPath(String inputPath) OPTIONAL.
ParallelState.Builder	outputPath(String outputPath) OPTIONAL.
ParallelState.Builder	parameters(Object parameters) OPTIONAL.
ParallelState.Builder	parameters(String parameters) OPTIONAL.
ParallelState.Builder	resultPath(String resultPath) OPTIONAL.
ParallelState.Builder	retrier(Retrier.Builder retrierBuilder) OPTIONAL.
ParallelState.Builder	retriers(Retrier.Builder... retrierBuilders) OPTIONAL.
ParallelState.Builder	transition(Transition.Builder builder) REQUIRED.

Methods inherited from class java.lang.Object

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

Method Detail

comment

public ParallelState.Builder comment(String comment)

OPTIONAL. Human readable description for the state.

Parameters:

comment - New comment.

Returns:

This object for method chaining.

branch

public ParallelState.Builder branch(Branch.Builder branchBuilder)

REQUIRED. Adds a new branch of execution to this states branches. A parallel state must have at least one branch.

Parameters:

branchBuilder - Instance of Branch.Builder. Note that the Branch object is not built until the ParallelState is built so any modifications on the state builder will be reflected in this object.

Returns:

This object for method chaining.

branches

public ParallelState.Builder branches(Branch.Builder... branchBuilders)

REQUIRED. Adds the branches of execution to this states branches. A parallel state must have at least one branch.

Parameters:

branchBuilders - Instances of Branch.Builder. Note that the Branch object is not built until the ParallelState is built so any modifications on the state builder will be reflected in this object.

Returns:

This object for method chaining.

inputPath

public ParallelState.Builder inputPath(String inputPath)

Description copied from interface: InputOutputPathBuilder

OPTIONAL. The value of “InputPath” MUST be a Path, which is applied to a State’s raw input to select some or all of it; that selection is used by the state. If not provided then the whole output from the previous state is used as input to this state.

Specified by:

inputPath in interface InputOutputPathBuilder<ParallelState.Builder>

Parameters:

inputPath - New path value.

Returns:

This object for method chaining.

resultPath

public ParallelState.Builder resultPath(String resultPath)

Description copied from interface: ResultPathBuilder

OPTIONAL. The value of “ResultPath” MUST be a Reference Path, which specifies the combination with or replacement of the state’s result with its raw input. If not provided then the output completely replaces the input.

Specified by:

resultPath in interface ResultPathBuilder<ParallelState.Builder>

Parameters:

resultPath - New path value.

Returns:

This object for method chaining.

outputPath

public ParallelState.Builder outputPath(String outputPath)

Description copied from interface: InputOutputPathBuilder

OPTIONAL. The value of “OutputPath” MUST be a path, which is applied to the state’s output after the application of ResultPath, leading in the generation of the raw input for the next state. If not provided then the whole output is used.

Specified by:

outputPath in interface InputOutputPathBuilder<ParallelState.Builder>

Parameters:

outputPath - New path value.

Returns:

This object for method chaining.

parameters

public ParallelState.Builder parameters(String parameters)

Description copied from interface: ParametersBuilder

OPTIONAL. The value of "Parameters" MUST be a valid JSON document. This field forms the effective input to the Task if present. Values from the input to the state can be interpolated via a JSON path expression. To be interpolated the field name of the JSON object must end in the suffix ".$". See example below.

Given the following Parameters definition.

 
 {
 ...
   "Parameters": {
      "flagged": true,
      "parts": {
         "first.$": "$.vals[0]",
         "last3.$": "$.vals[3:]"
      }
   }
 ...
 }
 
 

And suppose that the input to the state is as follows:

 
 {
    "flagged": 7,
    "vals": [0, 10, 20, 30, 40, 50]
 }
 
 

Then the effective input to the task will be as follows:

 
 {
    "flagged": true,
    "parts": {
       "first": 0,
       "last3": [30, 40, 50]
    }
 }
 
 

Specified by:

parameters in interface ParametersBuilder<ParallelState.Builder>

Parameters:

parameters - Raw JSON string representing Parameters value.

Returns:

This object for method chaining.

parameters

public ParallelState.Builder parameters(Object parameters)

Description copied from interface: ParametersBuilder

OPTIONAL. The value of "Parameters" MUST be a valid JSON document. This field forms the effective input to the Task if present. Values from the input to the state can be interpolated via a JSON path expression. To be interpolated the field name of the JSON object must end in the suffix ".$". See example below.

Given the following Parameters definition.

 
 {
 ...
   "Parameters": {
      "flagged": true,
      "parts": {
         "first.$": "$.vals[0]",
         "last3.$": "$.vals[3:]"
      }
   }
 ...
 }
 
 

And suppose that the input to the state is as follows:

 
 {
    "flagged": 7,
    "vals": [0, 10, 20, 30, 40, 50]
 }
 
 

Then the effective input to the task will be as follows:

 
 {
    "flagged": true,
    "parts": {
       "first": 0,
       "last3": [30, 40, 50]
    }
 }
 
 

Specified by:

parameters in interface ParametersBuilder<ParallelState.Builder>

Parameters:

parameters - Object that will be serialized into the JSON document representing this states parameters.

Returns:

This object for method chaining.

transition

public ParallelState.Builder transition(Transition.Builder builder)

REQUIRED. Sets the transition that will occur when all branches in this parallel state have executed successfully.

Parameters:

builder - New transition.

Returns:

This object for method chaining.

retriers

public ParallelState.Builder retriers(Retrier.Builder... retrierBuilders)

OPTIONAL. Adds the Retriers to this states retries. If a single branch fails then the entire parallel state is considered failed and eligible for retry.

Parameters:

retrierBuilders - Instances of Retrier.Builder. Note that the Retrier object is not built until the ParallelState is built so any modifications on the state builder will be reflected in this object.

Returns:

This object for method chaining.

retrier

public ParallelState.Builder retrier(Retrier.Builder retrierBuilder)

OPTIONAL. Adds the Retrier to this states retries. If a single branch fails then the entire parallel state is considered failed and eligible for retry.

Parameters:

retrierBuilder - Instance of Retrier.Builder. Note that the Retrier object is not built until the ParallelState is built so any modifications on the state builder will be reflected in this object.

Returns:

This object for method chaining.

catchers

public ParallelState.Builder catchers(Catcher.Builder... catcherBuilders)

OPTIONAL. Adds the Catchers to this states catchers. If a single branch fails then the entire parallel state is considered failed and eligible to be caught.

Parameters:

catcherBuilders - Instances of Catcher.Builder. Note that the Catcher object is not built until the ParallelState is built so any modifications on the state builder will be reflected in this object.

Returns:

This object for method chaining.

catcher

public ParallelState.Builder catcher(Catcher.Builder catcherBuilder)

OPTIONAL. Adds the Catcher to this states catchers. If a single branch fails then the entire parallel state is considered failed and eligible to be caught.

Parameters:

catcherBuilder - Instance of Catcher.Builder. Note that the Catcher object is not built until the ParallelState is built so any modifications on the state builder will be reflected in this object.

Returns:

This object for method chaining.

build

public ParallelState build()

Specified by:

build in interface Buildable<State>

Returns:

An immutable ParallelState object.