com.amazonaws.services.stepfunctions.builder.states

Class TaskState.Builder

java.lang.Object

com.amazonaws.services.stepfunctions.builder.states.TaskState.Builder

All Implemented Interfaces:

Buildable<State>, InputOutputPathBuilder<TaskState.Builder>, InputOutputResultPathBuilder<TaskState.Builder>, ResultPathBuilder<TaskState.Builder>, State.Builder

Enclosing class:

TaskState

public static final class TaskState.Builder
extends Object
implements InputOutputResultPathBuilder<TaskState.Builder>

Builder for a TaskState.

Nested Class Summary

Nested classes/interfaces inherited from interface com.amazonaws.services.stepfunctions.builder.internal.Buildable

Buildable.Utils

Method Summary

Modifier and Type	Method and Description
TaskState	build()
TaskState.Builder	catcher(Catcher.Builder catcherBuilder) OPTIONAL.
TaskState.Builder	catchers(Catcher.Builder... catcherBuilders) OPTIONAL.
TaskState.Builder	comment(String comment) OPTIONAL.
TaskState.Builder	heartbeatSeconds(Integer heartbeatSeconds) OPTIONAL.
TaskState.Builder	inputPath(String inputPath) OPTIONAL.
TaskState.Builder	outputPath(String outputPath) OPTIONAL.
TaskState.Builder	resource(String resource) REQUIRED.
TaskState.Builder	resultPath(String resultPath) OPTIONAL.
TaskState.Builder	retrier(Retrier.Builder retrierBuilder) OPTIONAL.
TaskState.Builder	retriers(Retrier.Builder... retrierBuilders) OPTIONAL.
TaskState.Builder	timeoutSeconds(Integer timeoutSeconds) OPTIONAL.
TaskState.Builder	transition(Transition.Builder transition) REQUIRED.

Methods inherited from class java.lang.Object

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

Method Detail

resource

public TaskState.Builder resource(String resource)

REQUIRED. Sets the resource to be executed by this task. Must be a URI that uniquely identifies the specific task to execute. This may be the ARN of a Lambda function or a States Activity.

Parameters:

resource - URI of resource.

Returns:

This object for method chaining.

inputPath

public TaskState.Builder inputPath(String inputPath)

Description copied from interface: InputOutputPathBuilder

OPTIONAL. The value of “InputPath” MUST be a Path, which is applied to a State’s raw input to select some or all of it; that selection is used by the state. If not provided then the whole output from the previous state is used as input to this state.

Specified by:

inputPath in interface InputOutputPathBuilder<TaskState.Builder>

Parameters:

inputPath - New path value.

Returns:

This object for method chaining.

resultPath

public TaskState.Builder resultPath(String resultPath)

Description copied from interface: ResultPathBuilder

OPTIONAL. The value of “ResultPath” MUST be a Reference Path, which specifies the combination with or replacement of the state’s result with its raw input. If not provided then the output completely replaces the input.

Specified by:

resultPath in interface ResultPathBuilder<TaskState.Builder>

Parameters:

resultPath - New path value.

Returns:

This object for method chaining.

outputPath

public TaskState.Builder outputPath(String outputPath)

Description copied from interface: InputOutputPathBuilder

OPTIONAL. The value of “OutputPath” MUST be a path, which is applied to the state’s output after the application of ResultPath, leading in the generation of the raw input for the next state. If not provided then the whole output is used.

Specified by:

outputPath in interface InputOutputPathBuilder<TaskState.Builder>

Parameters:

outputPath - New path value.

Returns:

This object for method chaining.

comment

public TaskState.Builder comment(String comment)

OPTIONAL. Human readable description for the state.

Parameters:

comment - New comment.

Returns:

This object for method chaining.

timeoutSeconds

public TaskState.Builder timeoutSeconds(Integer timeoutSeconds)

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

Parameters:

timeoutSeconds - Timeout value.

Returns:

This object for method chaining.

heartbeatSeconds

public TaskState.Builder heartbeatSeconds(Integer heartbeatSeconds)

OPTIONAL. Allowed time between "Heartbeats". If the task does not send "Heartbeats" within the timeout then execution fails with a ErrorCodes.TIMEOUT. If not set then no heartbeats are required. Heartbeats are a more granular way for a task to report it's progress to the state machine.

Parameters:

heartbeatSeconds - Heartbeat value.

Returns:

This object for method chaining.

transition

public TaskState.Builder transition(Transition.Builder transition)

REQUIRED. Sets the transition that will occur when the task completes successfully.

Parameters:

transition - New transition.

Returns:

This object for method chaining.

retriers

public TaskState.Builder retriers(Retrier.Builder... retrierBuilders)

OPTIONAL. Adds the Retriers to this states retriers. If the task exits abnormally (throws exception, times out, etc) it will be considered failed and eligible to be retried.

Parameters:

retrierBuilders - Instances of Retrier.Builder. Note that the Retrier object is not built until the ParallelState is built so any modifications on the state builder will be reflected in this object.

Returns:

This object for method chaining.

retrier

public TaskState.Builder retrier(Retrier.Builder retrierBuilder)

OPTIONAL. Adds the Retrier to this states retriers. If the task exits abnormally (throws exception, times out, etc) it will be considered failed and eligible to be retried.

Parameters:

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

Returns:

This object for method chaining.

catchers

public TaskState.Builder catchers(Catcher.Builder... catcherBuilders)

OPTIONAL. Adds the Catchers to this states catchers. If the task exits abnormally (throws exception, times out, etc) it will be considered failed and eligible to be caught.

Parameters:

catcherBuilders - Instances of Catcher.Builder. Note that the Catcher object is not built until the TaskState is built so any modifications on the state builder will be reflected in this object.

Returns:

This object for method chaining.

catcher

public TaskState.Builder catcher(Catcher.Builder catcherBuilder)

OPTIONAL. Adds the Catcher to this states catchers. If the task exits abnormally (throws exception, times out, etc) it will be considered failed and eligible to be caught.

Parameters:

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

Returns:

This object for method chaining.

build

public TaskState build()

Specified by:

build in interface Buildable<State>

Returns:

An immutable TaskState object.