com.amazonaws.services.stepfunctions.builder

Class StateMachine.Builder

java.lang.Object

com.amazonaws.services.stepfunctions.builder.StateMachine.Builder

Enclosing class:

StateMachine

public static final class StateMachine.Builder
extends Object

Builder for a StateMachine.

Method Summary

Modifier and Type	Method and Description
StateMachine	build()
StateMachine.Builder	comment(String comment) OPTIONAL.
StateMachine.Builder	startAt(String startAt) REQUIRED.
StateMachine.Builder	state(String stateName, State.Builder stateBuilder) REQUIRED.
StateMachine.Builder	timeoutSeconds(Integer timeoutSeconds) OPTIONAL.
StateMachine.Builder	version(String version) OPTIONAL.

Methods inherited from class java.lang.Object

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

Method Detail

comment

public StateMachine.Builder comment(String comment)

OPTIONAL. Human readable description for the state machine.

Parameters:

comment - New comment.

Returns:

This object for method chaining.

startAt

public StateMachine.Builder startAt(String startAt)

REQUIRED. Name of the state to start execution at. Must match a state name provided via state(String, State.Builder).

Parameters:

startAt - Name of starting state.

Returns:

This object for method chaining.

timeoutSeconds

public StateMachine.Builder timeoutSeconds(Integer timeoutSeconds)

OPTIONAL. Timeout, in seconds, that a state machine is allowed to run. If the machine execution runs longer than this timeout the execution fails with a ErrorCodes.TIMEOUT error

Parameters:

timeoutSeconds - Timeout value.

Returns:

This object for method chaining.

state

public StateMachine.Builder state(String stateName,
                                  State.Builder stateBuilder)

REQUIRED. Adds a new state to the state machine. A state machine MUST have at least one state.

Parameters:

stateName - Name of the state

stateBuilder - Instance of State.Builder. Note that the State object is not built until the StateMachine is built so any modifications on the state builder will be reflected in this object.

Returns:

This object for method chaining.

version

public StateMachine.Builder version(String version)

OPTIONAL. Version of the states language, if specified.

Parameters:

version - Version value.

Returns:

This object for method chaining.

build

public StateMachine build()

Returns:

An immutable StateMachine object that can be transformed to JSON via StateMachine.toJson().