com.amazonaws.services.stepfunctions.builder.states

Class FailState

java.lang.Object

com.amazonaws.services.stepfunctions.builder.states.FailState

All Implemented Interfaces:

State

public final class FailState
extends Object
implements State

Terminal state that terminates the state machine and marks it as a failure.

See Also:

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from interface com.amazonaws.services.stepfunctions.builder.states.State

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

getType

public String getType()

Specified by:

getType in interface State

Returns:

Type identifier of FailState.

getComment

public String getComment()

Returns:

Human readable description for the state.

getError

public String getError()

Returns:

Error code that can be referenced in Retriers or Catchers and can also be used for diagnostic purposes.

getCause

public String getCause()

Returns:

Human readable message describing the failure. Used for diagnostic purposes only.

isTerminalState

public boolean isTerminalState()

FailState 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

builder

public static FailState.Builder builder()

Returns:

Builder instance to construct a FailState.