com.amazonaws.services.stepfunctions.builder.states

Class PassState.Builder

java.lang.Object

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

All Implemented Interfaces:

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

Enclosing class:

PassState

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

Builder for a PassState.

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
PassState	build()
PassState.Builder	comment(String comment) OPTIONAL.
PassState.Builder	inputPath(String inputPath) OPTIONAL.
PassState.Builder	outputPath(String outputPath) OPTIONAL.
PassState.Builder	parameters(Object parameters) OPTIONAL.
PassState.Builder	parameters(String parameters) OPTIONAL.
PassState.Builder	result(Object result) OPTIONAL.
PassState.Builder	result(String result) OPTIONAL.
PassState.Builder	resultPath(String resultPath) OPTIONAL.
PassState.Builder	transition(Transition.Builder transition) REQUIRED.

Methods inherited from class java.lang.Object

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

Method Detail

comment

public PassState.Builder comment(String comment)

OPTIONAL. Human readable description for the state.

Parameters:

comment - New comment.

Returns:

This object for method chaining.

result

public PassState.Builder result(Object result)

OPTIONAL. Sets the "virtual" result of the pass state. Must be a POJO that can be serialized into JSON.

Parameters:

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

Returns:

This object for method chaining.

result

public PassState.Builder result(String result)

OPTIONAL. Sets the "virtual" result of the pass state. Must be a valid JSON document.

Parameters:

result - JSON result represented as a string.

Returns:

This object for method chaining.

inputPath

public PassState.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<PassState.Builder>

Parameters:

inputPath - New path value.

Returns:

This object for method chaining.

outputPath

public PassState.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<PassState.Builder>

Parameters:

outputPath - New path value.

Returns:

This object for method chaining.

resultPath

public PassState.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<PassState.Builder>

Parameters:

resultPath - New path value.

Returns:

This object for method chaining.

parameters

public PassState.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<PassState.Builder>

Parameters:

parameters - Raw JSON string representing Parameters value.

Returns:

This object for method chaining.

parameters

public PassState.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<PassState.Builder>

Parameters:

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

Returns:

This object for method chaining.

transition

public PassState.Builder transition(Transition.Builder transition)

REQUIRED. Sets the transition that will occur when this state completes successfully.

Parameters:

transition - New transition.

Returns:

This object for method chaining.

build

public PassState build()

Specified by:

build in interface Buildable<State>

Returns:

An immutable PassState object.