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

Class WaitState.Builder

java.lang.Object

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

All Implemented Interfaces:

Buildable<State>, State.Builder

Enclosing class:

WaitState

public static final class WaitState.Builder
extends Object

Builder for a WaitState.

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
WaitState	build()
WaitState.Builder	comment(String comment)	OPTIONAL.
WaitState.Builder	inputPath(String inputPath)	OPTIONAL.
WaitState.Builder	outputPath(String outputPath)	OPTIONAL.
WaitState.Builder	transition(Transition.Builder transition)	REQUIRED.
WaitState.Builder	waitFor(WaitFor.Builder waitFor)	REQUIRED.

Methods inherited from class java.lang.Object

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

Method Detail

comment

public WaitState.Builder comment(String comment)

OPTIONAL. Human readable description for the state.

Parameters:

comment - New comment.

Returns:

This object for method chaining.

waitFor

public WaitState.Builder waitFor(WaitFor.Builder waitFor)

REQUIRED. Implementation of WaitFor that indicates how long the state should wait before proceeding.

Parameters:

waitFor - Implementation of WaitFor

Returns:

This object for method chaining.

inputPath

public WaitState.Builder inputPath(String inputPath)

OPTIONAL. The value of “InputPath” MUST be a Path, which is applied to the previous State’s output to select some or all of it to form the input for this 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 WaitState.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.

transition

public WaitState.Builder transition(Transition.Builder transition)

REQUIRED. Sets the transition that will occur when the wait is completed.

Parameters:

transition - New transition.

Returns:

This object for method chaining.

build

public WaitState build()

Returns:

An immutable WaitState object.