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

Class SucceedState.Builder

java.lang.Object

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

All Implemented Interfaces:

Buildable<State>, State.Builder

Enclosing class:

SucceedState

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

Builder for a SucceedState.

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 and Description
SucceedState	build()
SucceedState.Builder	comment(String comment) OPTIONAL.
SucceedState.Builder	inputPath(String inputPath) OPTIONAL.
SucceedState.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 SucceedState.Builder comment(String comment)

OPTIONAL. Human readable description for the state.

Parameters:

comment - New comment.

Returns:

This object for method chaining.

inputPath

public SucceedState.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 SucceedState.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 SucceedState build()

Specified by:

build in interface Buildable<State>

Returns:

An immutable SucceedState object.