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

Class SucceedState

java.lang.Object

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

All Implemented Interfaces:

State

public final class SucceedState
extends Object
implements State

The Succeed State terminates a state machine successfully. The Succeed State is a useful target for Choice-state branches that don't do anything but terminate the machine.

See Also:

https://states-language.net/spec.html#succeed-state

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SucceedState.Builder Builder for a SucceedState.

Field Summary

Fields inherited from interface software.amazon.awssdk.services.stepfunctions.builder.states.State

CHOICE, FAIL, PARALLEL, PASS, SUCCEED, TASK, WAIT

Method Summary

Modifier and Type	Method and Description
<T> T	accept(StateVisitor<T> visitor)
static SucceedState.Builder	builder()
String	getComment()
String	getInputPath()
String	getOutputPath()
String	getType()
boolean	isTerminalState() SucceedState is always a terminal state.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static SucceedState.Builder builder()

Returns:

Builder instance to construct a SucceedState.

getType

public String getType()

Specified by:

getType in interface State

Returns:

Type identifier of SucceedState.

getComment

public String getComment()

Returns:

Human readable description for the state.

getInputPath

public String getInputPath()

Returns:

The input path expression that may optionally transform the input to this state.

getOutputPath

public String getOutputPath()

Returns:

The output path expression that may optionally transform the output to this state.

isTerminalState

public boolean isTerminalState()

SucceedState is always a terminal state.

Specified by:

isTerminalState in interface State

Returns:

True.

accept

public <T> T accept(StateVisitor<T> visitor)

Specified by:

accept in interface State