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

Class FailState.Builder

java.lang.Object

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

All Implemented Interfaces:

Buildable<State>, State.Builder

Enclosing class:

FailState

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

Builder for a FailState.

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
FailState	build()
FailState.Builder	cause(String cause)	REQUIRED.
FailState.Builder	comment(String comment)	OPTIONAL.
FailState.Builder	error(String error)	REQUIRED.

Methods inherited from class java.lang.Object

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

Method Detail

comment

public FailState.Builder comment(String comment)

OPTIONAL. Human readable description for the state.

Parameters:

comment - New comment.

Returns:

This object for method chaining.

error

public FailState.Builder error(String error)

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

Parameters:

error - Error code value.

Returns:

This object for method chaining.

cause

public FailState.Builder cause(String cause)

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

Parameters:

cause - Cause description.

Returns:

This object for method chaining.

build

public FailState build()

Specified by:

build in interface Buildable<State>

Returns:

An immutable FailState object.