TaskState.Builder (AWS Java SDK for AWS Step Functions 1.12.100 API)

java.lang.Object
- com.amazonaws.services.stepfunctions.builder.states.TaskState.Builder

All Implemented Interfaces:

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

Enclosing class:

TaskState
```
public static final class TaskState.Builder
extends Object
implements InputOutputResultPathBuilder<TaskState.Builder>, ParametersBuilder<TaskState.Builder>, ResultSelectorBuilder<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

All Methods Instance Methods Concrete Methods
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`	`heartbeatSecondsPath(String heartbeatSecondsPath)` OPTIONAL.
`TaskState.Builder`	`inputPath(String inputPath)` OPTIONAL.
`TaskState.Builder`	`outputPath(String outputPath)` OPTIONAL.
`TaskState.Builder`	`parameters(Object parameters)` OPTIONAL.
`TaskState.Builder`	`parameters(String parameters)` OPTIONAL.
`TaskState.Builder`	`resource(String resource)` REQUIRED.
`TaskState.Builder`	`resultPath(String resultPath)` OPTIONAL.
`TaskState.Builder`	`resultSelector(Object resultSelector)` OPTIONAL.
`TaskState.Builder`	`resultSelector(String resultSelector)` OPTIONAL.
`TaskState.Builder`	`retrier(Retrier.Builder retrierBuilder)` OPTIONAL.
`TaskState.Builder`	`retriers(Retrier.Builder... retrierBuilders)` OPTIONAL.
`TaskState.Builder`	`timeoutSeconds(Integer timeoutSeconds)` OPTIONAL.
`TaskState.Builder`	`timeoutSecondsPath(String timeoutSecondsPath)` 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.
  - parameters
```
public TaskState.Builder parameters(String parameters)
```
    Description copied from interface: ParametersBuilder
    OPTIONAL. The value of "Parameters" MUST be a valid JSON document. This field forms the effective input to the Task if present. Values from the input to the state can be interpolated via a JSON path expression. To be interpolated the field name of the JSON object must end in the suffix ".$". See example below.
    Given the following Parameters definition.
```
 
 {
 ...
   "Parameters": {
      "flagged": true,
      "parts": {
         "first.$": "$.vals[0]",
         "last3.$": "$.vals[3:]"
      }
   }
 ...
 }
 
 
```
    And suppose that the input to the state is as follows:
```
 
 {
    "flagged": 7,
    "vals": [0, 10, 20, 30, 40, 50]
 }
 
 
```
    Then the effective input to the task will be as follows:
```
 
 {
    "flagged": true,
    "parts": {
       "first": 0,
       "last3": [30, 40, 50]
    }
 }
 
 
```
    Specified by:
    
    parameters in interface ParametersBuilder<TaskState.Builder>
    
    Parameters:
    
    parameters - Raw JSON string representing Parameters value.
    
    Returns:
    
    This object for method chaining.
  - parameters
```
public TaskState.Builder parameters(Object parameters)
```
    Description copied from interface: ParametersBuilder
    OPTIONAL. The value of "Parameters" MUST be a valid JSON document. This field forms the effective input to the Task if present. Values from the input to the state can be interpolated via a JSON path expression. To be interpolated the field name of the JSON object must end in the suffix ".$". See example below.
    Given the following Parameters definition.
```
 
 {
 ...
   "Parameters": {
      "flagged": true,
      "parts": {
         "first.$": "$.vals[0]",
         "last3.$": "$.vals[3:]"
      }
   }
 ...
 }
 
 
```
    And suppose that the input to the state is as follows:
```
 
 {
    "flagged": 7,
    "vals": [0, 10, 20, 30, 40, 50]
 }
 
 
```
    Then the effective input to the task will be as follows:
```
 
 {
    "flagged": true,
    "parts": {
       "first": 0,
       "last3": [30, 40, 50]
    }
 }
 
 
```
    Specified by:
    
    parameters in interface ParametersBuilder<TaskState.Builder>
    
    Parameters:
    
    parameters - Object that will be serialized into the JSON document representing this states parameters.
    
    Returns:
    
    This object for method chaining.
  - resultSelector
```
public TaskState.Builder resultSelector(String resultSelector)
```
    Description copied from interface: ResultSelectorBuilder
    OPTIONAL. The value of "ResultSelector" MUST be a Payload Template which is a JSON object, whose input is the result, and whose payload replaces and becomes the effective result. Values from the result of the state can be interpolated via a JSON path expression. To be interpolated the field name of the JSON object must end in the suffix ".$". See example below.
    Given the following ResultSelector and ResultPath definition.
```
 
 {
 ...
   "ResultSelector": {
     "ClusterId.$": "$.output.ClusterId",
     "ResourceType.$": "$.resourceType"
   },
   "ResultPath": "$.EMROutput"
 ...
 }
 
 
```
    Suppose the result of the Task is as follows:
```
 
 {
 ...
   "resourceType": "elasticmapreduce",
   "output": {
     "ClusterId": "AKIAIOSFODNN7EXAMPLE"
   }
 ...
 }
 
 
```
    Then the effective result from the task will be as follows:
```
 
 {
 ...
   "EMROutput": {
     "ClusterId": "AKIAIOSFODNN7EXAMPLE",
     "ResourceType": "elasticmapreduce"
   }
 ...
 }

 
 
```
    Specified by:
    
    resultSelector in interface ResultSelectorBuilder<TaskState.Builder>
    
    Parameters:
    
    resultSelector - Raw JSON string representing ResultSelector value.
    
    Returns:
    
    This object for method chaining.
  - resultSelector
```
public TaskState.Builder resultSelector(Object resultSelector)
```
    Description copied from interface: ResultSelectorBuilder
    OPTIONAL. The value of "ResultSelector" MUST be a Payload Template which is a JSON object, whose input is the result, and whose payload replaces and becomes the effective result. Values from the result of the state can be interpolated via a JSON path expression. To be interpolated the field name of the JSON object must end in the suffix ".$". See example below.
    Given the following ResultSelector and ResultPath definition.
```
 
 {
 ...
   "ResultSelector": {
     "ClusterId.$": "$.output.ClusterId",
     "ResourceType.$": "$.resourceType"
   },
   "ResultPath": "$.EMROutput"
 ...
 }
 
 
```
    Suppose the result of the Task is as follows:
```
 
 {
 ...
   "resourceType": "elasticmapreduce",
   "output": {
     "ClusterId": "AKIAIOSFODNN7EXAMPLE"
   }
 ...
 }
 
 
```
    Then the effective result from the task will be as follows:
```
 
 {
 ...
   "EMROutput": {
     "ClusterId": "AKIAIOSFODNN7EXAMPLE",
     "ResourceType": "elasticmapreduce"
   }
 ...
 }

 
 
```
    Specified by:
    
    resultSelector in interface ResultSelectorBuilder<TaskState.Builder>
    
    Parameters:
    
    resultSelector - Object that will be serialized into the JSON document representing this state's ResultSelector.
    
    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. TimeoutSeconds and TimeoutSecondsPath are mutually exclusive fields.
    
    Parameters:
    
    timeoutSeconds - Timeout value.
    
    Returns:
    
    This object for method chaining.
  - timeoutSecondsPath
```
public TaskState.Builder timeoutSecondsPath(String timeoutSecondsPath)
```
    OPTIONAL. 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. TimeoutSeconds and TimeoutSecondsPath are mutually exclusive fields.
    
    Parameters:
    
    timeoutSecondsPath - Reference path to Timeout value in the input.
    
    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. HeartbeatSeconds and HeartbeatSecondsPath are mutually exclusive fields.
    
    Parameters:
    
    heartbeatSeconds - Heartbeat value.
    
    Returns:
    
    This object for method chaining.
  - heartbeatSecondsPath
```
public TaskState.Builder heartbeatSecondsPath(String heartbeatSecondsPath)
```
    OPTIONAL. Reference path to 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. HeartbeatSeconds and HeartbeatSecondsPath are mutually exclusive fields.
    
    Parameters:
    
    heartbeatSecondsPath - Reference path to Heartbeat value in the input.
    
    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.

Class TaskState.Builder

Nested Class Summary

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

Method Summary

Methods inherited from class java.lang.Object

Method Detail

resource

inputPath

resultPath

outputPath

parameters

parameters

resultSelector

resultSelector

comment

timeoutSeconds

timeoutSecondsPath

heartbeatSeconds

heartbeatSecondsPath

transition

retriers

retrier

catchers

catcher

build