com.amazonaws.services.stepfunctions.builder

Class StepFunctionBuilder

java.lang.Object

com.amazonaws.services.stepfunctions.builder.StepFunctionBuilder

public final class StepFunctionBuilder
extends Object

Fluent API for creating a StateMachine object.

Method Summary

Modifier and Type	Method and Description
static AndCondition.Builder	and(Condition.Builder... conditionBuilders) Represents the logical AND of multiple conditions.
static Branch.Builder	branch() A single branch of parallel execution in a state machine.
static Catcher.Builder	catcher() Catches an error from a ParallelState or a TaskState and transitions into the specified recovery state.
static Choice.Builder	choice() Class representing a choice rule to be included in a ChoiceState.
static ChoiceState.Builder	choiceState() A Choice state adds branching logic to a state machine.
static Transition.Builder	end() Transition indicating the state machine should terminate execution.
static BooleanEqualsCondition.Builder	eq(String variable, boolean expectedValue) Binary condition for Boolean equality comparison.
static TimestampEqualsCondition.Builder	eq(String variable, Date expectedValue) Binary condition for Timestamp equality comparison.
static NumericEqualsCondition.Builder	eq(String variable, double expectedValue) Binary condition for Numeric equality comparison.
static NumericEqualsCondition.Builder	eq(String variable, long expectedValue) Binary condition for Numeric equality comparison.
static StringEqualsCondition.Builder	eq(String variable, String expectedValue) Binary condition for String equality comparison.
static FailState.Builder	failState() Terminal state that terminates the state machine and marks it as a failure.
static TimestampGreaterThanCondition.Builder	gt(String variable, Date expectedValue) Binary condition for Timestamp greater than comparison.
static NumericGreaterThanCondition.Builder	gt(String variable, double expectedValue) Binary condition for Numeric greater than comparison.
static NumericGreaterThanCondition.Builder	gt(String variable, long expectedValue) Binary condition for Numeric greater than comparison.
static StringGreaterThanCondition.Builder	gt(String variable, String expectedValue) Binary condition for String greater than comparison.
static TimestampGreaterThanOrEqualCondition.Builder	gte(String variable, Date expectedValue) Binary condition for Timestamp greater than or equal to comparison.
static NumericGreaterThanOrEqualCondition.Builder	gte(String variable, double expectedValue) Binary condition for Numeric greater than comparison.
static NumericGreaterThanOrEqualCondition.Builder	gte(String variable, long expectedValue) Binary condition for Numeric greater than comparison.
static StringGreaterThanOrEqualCondition.Builder	gte(String variable, String expectedValue) Binary condition for String greater than or equal to comparison.
static TimestampLessThanCondition.Builder	lt(String variable, Date expectedValue) Binary condition for Timestamp less than comparison.
static NumericLessThanCondition.Builder	lt(String variable, double expectedValue) Binary condition for Numeric less than comparison.
static NumericLessThanCondition.Builder	lt(String variable, long expectedValue) Binary condition for Numeric less than comparison.
static StringLessThanCondition.Builder	lt(String variable, String expectedValue) Binary condition for String less than comparison.
static TimestampLessThanOrEqualCondition.Builder	lte(String variable, Date expectedValue) Binary condition for Timestamp less than or equal to comparison.
static NumericLessThanOrEqualCondition.Builder	lte(String variable, double expectedValue) Binary condition for Numeric less than or equal to comparison.
static NumericLessThanOrEqualCondition.Builder	lte(String variable, long expectedValue) Binary condition for Numeric less than or equal to comparison.
static StringLessThanOrEqualCondition.Builder	lte(String variable, String expectedValue) Binary condition for String less than or equal to comparison.
static NextStateTransition.Builder	next(String nextStateName) A transition to another state in the state machine.
static NotCondition.Builder	not(Condition.Builder conditionBuilder) Represents the logical NOT of a single condition.
static OrCondition.Builder	or(Condition.Builder... conditionBuilders) Represents the logical OR of multiple conditions.
static ParallelState.Builder	parallelState() State that allows for parallel execution of Branchs.
static PassState.Builder	passState() The Pass State simply passes its input to its output, performing no work.
static Retrier.Builder	retrier() Describes retry behavior for a state.
static WaitFor.Builder	seconds(int seconds) WaitFor that can be used in a WaitState.
static WaitFor.Builder	secondsPath(String secondsPath) WaitFor that can be used in a WaitState.
static StateMachine.Builder	stateMachine() Represents a StepFunctions state machine.
static SucceedState.Builder	succeedState() The Succeed State terminates a state machine successfully.
static TaskState.Builder	taskState() The Task State causes the interpreter to execute the work identified by the state’s “Resource” field.
static WaitFor.Builder	timestamp(Date timestamp) WaitFor that can be used in a WaitState.
static WaitFor.Builder	timestampPath(String timestampPath) WaitFor that can be used in a WaitState.
static WaitState.Builder	waitState() A Wait state causes the interpreter to delay the machine from continuing for a specified time.

Methods inherited from class java.lang.Object

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

Method Detail

stateMachine

public static StateMachine.Builder stateMachine()

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

Returns:

Builder used to configure a StateMachine.

See Also:

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

parallelState

public static ParallelState.Builder parallelState()

State that allows for parallel execution of Branchs. A Parallel state causes the interpreter to execute each branch starting with the state named in its “StartAt” field, as concurrently as possible, and wait until each branch terminates (reaches a terminal state) before processing the Parallel state's “Next” field.

Returns:

Builder used to configure a ParallelState.

See Also:

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

branch

public static Branch.Builder branch()

A single branch of parallel execution in a state machine. See ParallelState.

Returns:

Builder used to configure a Branch.

passState

public static PassState.Builder passState()

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.

Returns:

Builder used to configure a PassState.

See Also:

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

succeedState

public static SucceedState.Builder succeedState()

The Succeed State terminates a state machine successfully. The Succeed State is a useful target for Choice-state branches that don't do anything but terminate the machine.

Returns:

Builder used to configure a SucceedState.

See Also:

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

failState

public static FailState.Builder failState()

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

Returns:

Builder used to configure a FailState.

See Also:

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

waitState

public static WaitState.Builder waitState()

A Wait state causes the interpreter to delay the machine from continuing for a specified time. The time can be specified as a wait duration, specified in seconds, or an absolute expiry time, specified as an ISO-8601 extended offset date-time format string.

Returns:

Builder used to configure a WaitState.

See Also:

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

taskState

public static TaskState.Builder taskState()

The Task State causes the interpreter to execute the work identified by the state’s “Resource” field.

Currently allowed resources include Lambda functions and States activities.

Returns:

Builder used to configure a TaskState.

See Also:

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

choiceState

public static ChoiceState.Builder choiceState()

A Choice state adds branching logic to a state machine. A Choice state consists of a list of choices, each of which contains a potential transition state and a condition that determines if that choice is evaluated, and a default state that the state machine transitions to if no choice branches are matched.

Returns:

Builder used to configure a ChoiceState.

See Also:

choice

public static Choice.Builder choice()

Class representing a choice rule to be included in a ChoiceState. A choice consists of a condition and a state that the state machine will transition to if the condition evaluates to true.

Returns:

Builder used to configure a Choice.

See Also:

retrier

public static Retrier.Builder retrier()

Describes retry behavior for a state. A Retrier consists of a list of error codes that the retrier applies to and parameters controlling the behavior when a retry is performed.

Returns:

Builder used to configure a Retrier.

See Also:

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

catcher

public static Catcher.Builder catcher()

Catches an error from a ParallelState or a TaskState and transitions into the specified recovery state. The recovery state will receive the error output as input unless otherwise specified by a ResultPath.

Returns:

Builder used to configure a Catcher.

See Also:

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

eq

public static StringEqualsCondition.Builder eq(String variable,
                                               String expectedValue)

Binary condition for String equality comparison.

Parameters:

variable - The JSONPath expression that determines which piece of the input document is used for the comparison.

expectedValue - The expected value for this condition.

See Also:

https://states-language.net/spec.html#choice-state, Choice

eq

public static NumericEqualsCondition.Builder eq(String variable,
                                                long expectedValue)

Binary condition for Numeric equality comparison. Supports both integral and floating point numeric types.

Parameters:

variable - The JSONPath expression that determines which piece of the input document is used for the comparison.

expectedValue - The expected value for this condition.

See Also:

https://states-language.net/spec.html#choice-state, Choice

eq

public static NumericEqualsCondition.Builder eq(String variable,
                                                double expectedValue)

Binary condition for Numeric equality comparison. Supports both integral and floating point numeric types.

Parameters:

variable - The JSONPath expression that determines which piece of the input document is used for the comparison.

expectedValue - The expected value for this condition.

See Also:

https://states-language.net/spec.html#choice-state, Choice

eq

public static BooleanEqualsCondition.Builder eq(String variable,
                                                boolean expectedValue)

Binary condition for Boolean equality comparison.

Parameters:

variable - The JSONPath expression that determines which piece of the input document is used for the comparison.

expectedValue - The expected value for this condition.

See Also:

https://states-language.net/spec.html#choice-state, Choice

eq

public static TimestampEqualsCondition.Builder eq(String variable,
                                                  Date expectedValue)

Binary condition for Timestamp equality comparison. Dates are converted to ISO8601 UTC timestamps.

Parameters:

variable - The JSONPath expression that determines which piece of the input document is used for the comparison.

expectedValue - The expected value for this condition.

See Also:

https://states-language.net/spec.html#choice-state, Choice

gt

public static StringGreaterThanCondition.Builder gt(String variable,
                                                    String expectedValue)

Binary condition for String greater than comparison.

Parameters:

variable - The JSONPath expression that determines which piece of the input document is used for the comparison.

expectedValue - The expected value for this condition.

See Also:

https://states-language.net/spec.html#choice-state, Choice

gt

public static NumericGreaterThanCondition.Builder gt(String variable,
                                                     long expectedValue)

Binary condition for Numeric greater than comparison. Supports both integral and floating point numeric types.

Parameters:

variable - The JSONPath expression that determines which piece of the input document is used for the comparison.

expectedValue - The expected value for this condition.

See Also:

https://states-language.net/spec.html#choice-state, Choice

gt

public static NumericGreaterThanCondition.Builder gt(String variable,
                                                     double expectedValue)

Binary condition for Numeric greater than comparison. Supports both integral and floating point numeric types.

Parameters:

variable - The JSONPath expression that determines which piece of the input document is used for the comparison.

expectedValue - The expected value for this condition.

See Also:

https://states-language.net/spec.html#choice-state, Choice

gt

public static TimestampGreaterThanCondition.Builder gt(String variable,
                                                       Date expectedValue)

Binary condition for Timestamp greater than comparison. Dates are converted to ISO8601 UTC timestamps.

Parameters:

variable - The JSONPath expression that determines which piece of the input document is used for the comparison.

expectedValue - The expected value for this condition.

See Also:

https://states-language.net/spec.html#choice-state, Choice

gte

public static StringGreaterThanOrEqualCondition.Builder gte(String variable,
                                                            String expectedValue)

Binary condition for String greater than or equal to comparison.

Parameters:

variable - The JSONPath expression that determines which piece of the input document is used for the comparison.

expectedValue - The expected value for this condition.

See Also:

https://states-language.net/spec.html#choice-state, Choice

gte

public static NumericGreaterThanOrEqualCondition.Builder gte(String variable,
                                                             long expectedValue)

Binary condition for Numeric greater than comparison. Supports both integral and floating point numeric types.

Parameters:

variable - The JSONPath expression that determines which piece of the input document is used for the comparison.

expectedValue - The expected value for this condition.

See Also:

https://states-language.net/spec.html#choice-state, Choice

gte

public static NumericGreaterThanOrEqualCondition.Builder gte(String variable,
                                                             double expectedValue)

Binary condition for Numeric greater than comparison. Supports both integral and floating point numeric types.

Parameters:

variable - The JSONPath expression that determines which piece of the input document is used for the comparison.

expectedValue - The expected value for this condition.

See Also:

https://states-language.net/spec.html#choice-state, Choice

gte

public static TimestampGreaterThanOrEqualCondition.Builder gte(String variable,
                                                               Date expectedValue)

Binary condition for Timestamp greater than or equal to comparison. Dates are converted to ISO8601 UTC timestamps.

Parameters:

variable - The JSONPath expression that determines which piece of the input document is used for the comparison.

expectedValue - The expected value for this condition.

See Also:

https://states-language.net/spec.html#choice-state, Choice

lt

public static StringLessThanCondition.Builder lt(String variable,
                                                 String expectedValue)

Binary condition for String less than comparison.

Parameters:

variable - The JSONPath expression that determines which piece of the input document is used for the comparison.

expectedValue - The expected value for this condition.

See Also:

https://states-language.net/spec.html#choice-state, Choice

lt

public static NumericLessThanCondition.Builder lt(String variable,
                                                  long expectedValue)

Binary condition for Numeric less than comparison. Supports both integral and floating point numeric types.

Parameters:

variable - The JSONPath expression that determines which piece of the input document is used for the comparison.

expectedValue - The expected value for this condition.

See Also:

https://states-language.net/spec.html#choice-state, Choice

lt

public static NumericLessThanCondition.Builder lt(String variable,
                                                  double expectedValue)

Binary condition for Numeric less than comparison. Supports both integral and floating point numeric types.

Parameters:

variable - The JSONPath expression that determines which piece of the input document is used for the comparison.

expectedValue - The expected value for this condition.

See Also:

https://states-language.net/spec.html#choice-state, Choice

lt

public static TimestampLessThanCondition.Builder lt(String variable,
                                                    Date expectedValue)

Binary condition for Timestamp less than comparison. Dates are converted to ISO8601 UTC timestamps.

Parameters:

variable - The JSONPath expression that determines which piece of the input document is used for the comparison.

expectedValue - The expected value for this condition.

See Also:

https://states-language.net/spec.html#choice-state, Choice

lte

public static StringLessThanOrEqualCondition.Builder lte(String variable,
                                                         String expectedValue)

Binary condition for String less than or equal to comparison.

Parameters:

variable - The JSONPath expression that determines which piece of the input document is used for the comparison.

expectedValue - The expected value for this condition.

See Also:

https://states-language.net/spec.html#choice-state, Choice

lte

public static NumericLessThanOrEqualCondition.Builder lte(String variable,
                                                          long expectedValue)

Binary condition for Numeric less than or equal to comparison. Supports both integral and floating point numeric types.

Parameters:

variable - The JSONPath expression that determines which piece of the input document is used for the comparison.

expectedValue - The expected value for this condition.

See Also:

https://states-language.net/spec.html#choice-state, Choice

lte

public static NumericLessThanOrEqualCondition.Builder lte(String variable,
                                                          double expectedValue)

Binary condition for Numeric less than or equal to comparison. Supports both integral and floating point numeric types.

Parameters:

variable - The JSONPath expression that determines which piece of the input document is used for the comparison.

expectedValue - The expected value for this condition.

See Also:

https://states-language.net/spec.html#choice-state, Choice

lte

public static TimestampLessThanOrEqualCondition.Builder lte(String variable,
                                                            Date expectedValue)

Binary condition for Timestamp less than or equal to comparison. Dates are converted to ISO8601 UTC timestamps.

Parameters:

variable - The JSONPath expression that determines which piece of the input document is used for the comparison.

expectedValue - The expected value for this condition.

See Also:

https://states-language.net/spec.html#choice-state, Choice

not

public static NotCondition.Builder not(Condition.Builder conditionBuilder)

Represents the logical NOT of a single condition. May be used in a ChoiceState.

Parameters:

conditionBuilder - The condition to be negated. May be another composite condition or a simple condition.

Returns:

Builder used to configure a NotCondition.

See Also:

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

and

public static AndCondition.Builder and(Condition.Builder... conditionBuilders)

Represents the logical AND of multiple conditions. May be used in a ChoiceState.

Parameters:

conditionBuilders - The conditions to AND together. May be another composite condition or a simple condition.

Returns:

Builder used to configure a AndCondition.

See Also:

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

or

public static OrCondition.Builder or(Condition.Builder... conditionBuilders)

Represents the logical OR of multiple conditions. May be used in a ChoiceState.

Parameters:

conditionBuilders - The conditions to OR together. May be another composite condition or a simple condition.

Returns:

Builder used to configure a OrCondition.

See Also:

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

next

public static NextStateTransition.Builder next(String nextStateName)

A transition to another state in the state machine.

Parameters:

nextStateName - Name of state to transition to.

Returns:

Transition to another state in the state machine.

See Also:

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

end

public static Transition.Builder end()

Transition indicating the state machine should terminate execution.

Returns:

EndTransition

See Also:

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

seconds

public static WaitFor.Builder seconds(int seconds)

WaitFor that can be used in a WaitState. Instructs the WaitState to wait for the given number of seconds.

Parameters:

seconds - Number of seconds to wait. Must be positive.

See Also:

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

secondsPath

public static WaitFor.Builder secondsPath(String secondsPath)

WaitFor that can be used in a WaitState. Instructs the WaitState to wait for the number of seconds specified at the reference path in the input to the state.

Parameters:

secondsPath - Reference path to the location in the input data containing the number of seconds to wait.

See Also:

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

timestamp

public static WaitFor.Builder timestamp(Date timestamp)

WaitFor that can be used in a WaitState. Instructs the WaitState to wait until the given timestamp.

Parameters:

timestamp - Date to wait until before proceeding.

See Also:

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

timestampPath

public static WaitFor.Builder timestampPath(String timestampPath)

WaitFor that can be used in a WaitState. Instructs the WaitState to wait until the date specified at the reference path in the input to the state.

Parameters:

timestampPath - Reference path to the location in the input data containing the date to wait until.

See Also:

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