Package software.amazon.awssdk.services.stepfunctions.builder.states

Class PassState.Builder

java.lang.Object

software.amazon.awssdk.services.stepfunctions.builder.states.PassState.Builder

All Implemented Interfaces:

Buildable<State>, State.Builder

Enclosing class:

PassState

public static final class PassState.Builder
extends Object

Builder for a PassState.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awssdk.services.stepfunctions.builder.internal.Buildable

Buildable.Utils

Method Summary

Modifier and Type	Method	Description
PassState	build()
PassState.Builder	comment(String comment)	OPTIONAL.
PassState.Builder	inputPath(String inputPath)	OPTIONAL.
PassState.Builder	outputPath(String outputPath)	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)

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.

Parameters:

inputPath - New path value.

Returns:

This object for method chaining.

outputPath

public PassState.Builder outputPath(String outputPath)

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.

Parameters:

outputPath - New path value.

Returns:

This object for method chaining.

resultPath

public PassState.Builder resultPath(String resultPath)

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.

Parameters:

resultPath - New path value.

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()

Returns:

An immutable PassState object.