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

Class ChoiceState.Builder

java.lang.Object

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

All Implemented Interfaces:

Buildable<State>, State.Builder

Enclosing class:

ChoiceState

public static final class ChoiceState.Builder
extends Object
implements State.Builder

Builder for a ChoiceState.

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
ChoiceState	build()
ChoiceState.Builder	choice(Choice.Builder choiceBuilder)	REQUIRED.
ChoiceState.Builder	choices(Choice.Builder... choiceBuilders)	REQUIRED.
ChoiceState.Builder	comment(String comment)	OPTIONAL.
ChoiceState.Builder	defaultStateName(String defaultStateName)	OPTIONAL.
ChoiceState.Builder	inputPath(String inputPath)	OPTIONAL.
ChoiceState.Builder	outputPath(String outputPath)	OPTIONAL.

Methods inherited from class java.lang.Object

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

Method Detail

comment

public ChoiceState.Builder comment(String comment)

OPTIONAL. Human readable description for the state.

Parameters:

comment - New comment.

Returns:

This object for method chaining.

defaultStateName

public ChoiceState.Builder defaultStateName(String defaultStateName)

OPTIONAL. Name of state to transition to if no Choice rules match. If a default state is not provided and no choices match then a ErrorCodes.NO_CHOICE_MATCHED error is thrown.

Parameters:

defaultStateName - Name of default state.

Returns:

This object for method chaining.

choice

public ChoiceState.Builder choice(Choice.Builder choiceBuilder)

REQUIRED. Adds a new Choice rule to the ChoiceState. A ChoiceState must contain at least one choice rule.

Parameters:

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

Returns:

This object for method chaining.

choices

public ChoiceState.Builder choices(Choice.Builder... choiceBuilders)

REQUIRED. Adds the Choice rules to the ChoiceState. A ChoiceState must contain at least one choice rule.

Parameters:

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

Returns:

This object for method chaining.

inputPath

public ChoiceState.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 ChoiceState.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.

build

public ChoiceState build()

Specified by:

build in interface Buildable<State>

Returns:

An immutable ChoiceState object.