com.amazonaws.services.stepfunctions.builder.states

Class TaskState

java.lang.Object

com.amazonaws.services.stepfunctions.builder.states.TransitionState

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

All Implemented Interfaces:

State

public final class TaskState
extends TransitionState

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.

See Also:

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from interface com.amazonaws.services.stepfunctions.builder.states.State

CHOICE, FAIL, MAP, PARALLEL, PASS, SUCCEED, TASK, WAIT

Method Summary

Modifier and Type	Method and Description
<T> T	accept(StateVisitor<T> visitor)
static TaskState.Builder	builder()
List<Catcher>	getCatchers()
String	getComment()
Integer	getHeartbeatSeconds()
String	getHeartbeatSecondsPath()
String	getInputPath()
String	getOutputPath()
String	getParameters()
String	getResource()
String	getResultPath()
List<Retrier>	getRetriers()
Integer	getTimeoutSeconds()
String	getTimeoutSecondsPath()
Transition	getTransition()
String	getType()

Methods inherited from class com.amazonaws.services.stepfunctions.builder.states.TransitionState

isTerminalState

Methods inherited from class java.lang.Object

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

Method Detail

getType

public String getType()

Returns:

Type identifier of TaskState.

getResource

public String getResource()

Returns:

URI of the resource to be executed by this task.

getInputPath

public String getInputPath()

Returns:

The input path expression that may optionally transform the input to this state.

getResultPath

public String getResultPath()

Returns:

The result path expression that may optionally combine or replace the state's raw input with it's result.

getOutputPath

public String getOutputPath()

Returns:

The output path expression that may optionally transform the output to this state.

getParameters

public String getParameters()

Returns:

The Parameters JSON document that may optionally transform the effective input to the task.

getTransition

public Transition getTransition()

Specified by:

getTransition in class TransitionState

Returns:

The transition that will occur when this task completes successfully.

getComment

public String getComment()

Returns:

Human readable description for the state.

getTimeoutSeconds

public Integer getTimeoutSeconds()

Returns:

Timeout, in seconds, that a task is allowed to run.

getTimeoutSecondsPath

public String getTimeoutSecondsPath()

Returns:

Reference path to 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.

getHeartbeatSeconds

public Integer getHeartbeatSeconds()

Returns:

Allowed time between "Heartbeats".

getHeartbeatSecondsPath

public String getHeartbeatSecondsPath()

Returns:

Reference path to allowed time between "Heartbeats". If the task does not send "Heartbeats" within the timeout then execution fails with a ErrorCodes.TIMEOUT

getRetriers

public List<Retrier> getRetriers()

Returns:

The list of Retriers for this state.

getCatchers

public List<Catcher> getCatchers()

Returns:

The list of Catchers for this state.

accept

public <T> T accept(StateVisitor<T> visitor)

builder

public static TaskState.Builder builder()

Returns:

Builder instance to construct a TaskState.