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

Class StateMachine

java.lang.Object

software.amazon.awssdk.services.stepfunctions.builder.StateMachine

public final class StateMachine
extends Object

Represents a StepFunctions state machine. A state machine must have at least one state.

See Also:

https://states-language.net/spec.html#toplevelfields

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static StateMachine.Builder	builder()
static StateMachine.Builder	fromJson(String json)	Deserializes a JSON representation of a state machine into a StateMachine.Builder .
String	getComment()
String	getStartAt()
Map<String,State>	getStates()
Integer	getTimeoutSeconds()
String	toJson()
String	toPrettyJson()

Methods inherited from class java.lang.Object

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

Method Detail

fromJson

public static StateMachine.Builder fromJson(String json)

Deserializes a JSON representation of a state machine into a StateMachine.Builder .

Parameters:

json - JSON representing State machine.

Returns:

Mutable StateMachine.Builder deserialized from JSON representation.

builder

public static StateMachine.Builder builder()

Returns:

Builder instance to construct a StateMachine.

getComment

public String getComment()

Returns:

Human readable description for the state machine.

getStartAt

public String getStartAt()

Returns:

Name of the state to start execution at.

getTimeoutSeconds

public Integer getTimeoutSeconds()

Returns:

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

getStates

public Map<String,State> getStates()

Returns:

The states for this state machine.

toJson

public String toJson()

Returns:

Compact JSON representation of this StateMachine. May be provided to API calls (see software.amazon.awssdk.services.stepfunctions.AWSStepFunctions).

toPrettyJson

public String toPrettyJson()

Returns:

Formatted JSON representation of this StateMachine. May be provided to API calls (see software.amazon.awssdk.services.stepfunctions.AWSStepFunctions).