MapState.Builder (AWS Java SDK for AWS Step Functions 1.12.715 API)

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

All Implemented Interfaces:

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

Enclosing class:

MapState
```
public static final class MapState.Builder
extends Object
implements InputOutputResultItemsPathBuilder<MapState.Builder>, ParametersBuilder<MapState.Builder>, ResultSelectorBuilder<MapState.Builder>
```
Builder for a MapState.

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
`MapState`	`build()`
`MapState.Builder`	`catcher(Catcher.Builder catcherBuilder)` OPTIONAL.
`MapState.Builder`	`catchers(Catcher.Builder... catcherBuilders)` OPTIONAL.
`MapState.Builder`	`comment(String comment)` OPTIONAL.
`MapState.Builder`	`inputPath(String inputPath)` OPTIONAL.
`MapState.Builder`	`itemsPath(String itemsPath)` OPTIONAL.
`MapState.Builder`	`iterator(Iterator.Builder iteratorBuilder)` REQUIRED.
`MapState.Builder`	`maxConcurrency(Integer maxConcurrency)` OPTIONAL.
`MapState.Builder`	`outputPath(String outputPath)` OPTIONAL.
`MapState.Builder`	`parameters(Object parameters)` OPTIONAL.
`MapState.Builder`	`parameters(String parameters)` OPTIONAL.
`MapState.Builder`	`resultPath(String resultPath)` OPTIONAL.
`MapState.Builder`	`resultSelector(Object resultSelector)` OPTIONAL.
`MapState.Builder`	`resultSelector(String resultSelector)` OPTIONAL.
`MapState.Builder`	`retrier(Retrier.Builder retrierBuilder)` OPTIONAL.
`MapState.Builder`	`retriers(Retrier.Builder... retrierBuilders)` OPTIONAL.
`MapState.Builder`	`transition(Transition.Builder builder)` REQUIRED.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - comment
```
public MapState.Builder comment(String comment)
```
    OPTIONAL. Human readable description for the state.
    
    Parameters:
    
    comment - New comment.
    
    Returns:
    
    This object for method chaining.
  - maxConcurrency
```
public MapState.Builder maxConcurrency(Integer maxConcurrency)
```
    OPTIONAL. Max Concurrency provides an upper bound on how many invocations of the Iterator may run in parallel
    
    Parameters:
    
    maxConcurrency - New comment.
    
    Returns:
    
    This object for method chaining.
  - iterator
```
public MapState.Builder iterator(Iterator.Builder iteratorBuilder)
```
    REQUIRED. Iterator for this Map state.
    
    Parameters:
    
    iteratorBuilder - Instance of Iterator.Builder. Note that the Iterator object is not built until the MapState is built so any modifications on the state builder will be reflected in this object.
    
    Returns:
    
    This object for method chaining.
  - inputPath
```
public MapState.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<MapState.Builder>
    
    Parameters:
    
    inputPath - New path value.
    
    Returns:
    
    This object for method chaining.
  - resultPath
```
public MapState.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<MapState.Builder>
    
    Parameters:
    
    resultPath - New path value.
    
    Returns:
    
    This object for method chaining.
  - itemsPath
```
public MapState.Builder itemsPath(String itemsPath)
```
    Description copied from interface: InputOutputResultItemsPathBuilder
    
    OPTIONAL. The value of “ItemsPath” MUST be a path, with is a reference path identifying where in the effective input the array field is found. If not provided then the whole input is used. used.
    
    Specified by:
    
    itemsPath in interface InputOutputResultItemsPathBuilder<MapState.Builder>
    
    Parameters:
    
    itemsPath - New path value.
    
    Returns:
    
    This object for method chaining.
  - outputPath
```
public MapState.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<MapState.Builder>
    
    Parameters:
    
    outputPath - New path value.
    
    Returns:
    
    This object for method chaining.
  - parameters
```
public MapState.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<MapState.Builder>
    
    Parameters:
    
    parameters - Raw JSON string representing Parameters value.
    
    Returns:
    
    This object for method chaining.
  - parameters
```
public MapState.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<MapState.Builder>
    
    Parameters:
    
    parameters - Object that will be serialized into the JSON document representing this states parameters.
    
    Returns:
    
    This object for method chaining.
  - resultSelector
```
public MapState.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<MapState.Builder>
    
    Parameters:
    
    resultSelector - Raw JSON string representing ResultSelector value.
    
    Returns:
    
    This object for method chaining.
  - resultSelector
```
public MapState.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<MapState.Builder>
    
    Parameters:
    
    resultSelector - Object that will be serialized into the JSON document representing this state's ResultSelector.
    
    Returns:
    
    This object for method chaining.
  - transition
```
public MapState.Builder transition(Transition.Builder builder)
```
    REQUIRED. Sets the transition that will occur when all branches in this map state have executed successfully.
    
    Parameters:
    
    builder - New transition.
    
    Returns:
    
    This object for method chaining.
  - retriers
```
public MapState.Builder retriers(Retrier.Builder... retrierBuilders)
```
    OPTIONAL. Adds the Retriers to this states retries. If a single branch fails then the entire map state is considered failed and eligible for retry.
    
    Parameters:
    
    retrierBuilders - Instances of Retrier.Builder. Note that the Retrier object is not built until the MapState is built so any modifications on the state builder will be reflected in this object.
    
    Returns:
    
    This object for method chaining.
  - retrier
```
public MapState.Builder retrier(Retrier.Builder retrierBuilder)
```
    OPTIONAL. Adds the Retrier to this states retries. If a single branch fails then the entire map state is considered failed and eligible for retry.
    
    Parameters:
    
    retrierBuilder - Instance of Retrier.Builder. Note that the Retrier object is not built until the MapState is built so any modifications on the state builder will be reflected in this object.
    
    Returns:
    
    This object for method chaining.
  - catchers
```
public MapState.Builder catchers(Catcher.Builder... catcherBuilders)
```
    OPTIONAL. Adds the Catchers to this states catchers. If a single branch fails then the entire map state is considered failed and eligible to be caught.
    
    Parameters:
    
    catcherBuilders - Instances of Catcher.Builder. Note that the Catcher object is not built until the MapState is built so any modifications on the state builder will be reflected in this object.
    
    Returns:
    
    This object for method chaining.
  - catcher
```
public MapState.Builder catcher(Catcher.Builder catcherBuilder)
```
    OPTIONAL. Adds the Catcher to this states catchers. If a single branch fails then the entire map state is considered failed and eligible to be caught.
    
    Parameters:
    
    catcherBuilder - Instance of Catcher.Builder. Note that the Catcher object is not built until the MapState is built so any modifications on the state builder will be reflected in this object.
    
    Returns:
    
    This object for method chaining.
  - build
```
public MapState build()
```
    Specified by:
    
    build in interface Buildable<State>
    
    Returns:
    
    An immutable MapState object.

Class MapState.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

comment

maxConcurrency

iterator

inputPath

resultPath

itemsPath

outputPath

parameters

parameters

resultSelector

resultSelector

transition

retriers

retrier

catchers

catcher

build