com.amazonaws.services.stepfunctions.builder.states

Class PassState

java.lang.Object

com.amazonaws.services.stepfunctions.builder.states.TransitionState

com.amazonaws.services.stepfunctions.builder.states.PassState

All Implemented Interfaces:

State

public final class PassState
extends TransitionState

The Pass State simply passes its input to its output, performing no work. Pass States are useful when constructing and debugging state machines.

A Pass State MAY have a field named “Result”. If present, its value is treated as the output of a virtual task, and placed as prescribed by the “ResultPath” field, if any, to be passed on to the next state.

See Also:

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from interface com.amazonaws.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 PassState.Builder	builder()
String	getComment()
String	getInputPath()
String	getOutputPath()
String	getParameters()
String	getResult()
String	getResultPath()
Transition	getTransition()
String	getType()

Methods inherited from class com.amazonaws.services.stepfunctions.builder.states.TransitionState

isTerminalState

Methods inherited from class java.lang.Object

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

Method Detail

getType

public String getType()

Returns:

Type identifier of PassState.

getComment

public String getComment()

Returns:

Human readable description for the state.

getResult

public String getResult()

Returns:

String containing JSON document of the state's "virtual" result.

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.

getResultPath

public String getResultPath()

Returns:

The result path expression that may optionally combine or replace the state's raw input with it's result.

getParameters

public String getParameters()

Returns:

The Parameters JSON document that may optionally transform the effective input to the task.

getTransition

public Transition getTransition()

Specified by:

getTransition in class TransitionState

Returns:

The Transition for this state.

accept

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

builder

public static PassState.Builder builder()

Returns:

Builder instance to construct a PassState.