com.amazonaws.services.stepfunctions.builder.states

Class MapState

java.lang.Object

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

com.amazonaws.services.stepfunctions.builder.states.MapState

All Implemented Interfaces:

State

public final class MapState
extends TransitionState

State that allows for applying the same Iterator to multiple input elements. The Map State (identified by "Type": "Map") causes the interpreter to process all the elements of an array, potentially in parallel, with the processing of each element independent of the others.

See Also:

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

Nested Class Summary

Nested Classes

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

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 MapState.Builder	builder()
List<Catcher>	getCatchers()
String	getComment()
String	getInputPath()
String	getItemsPath()
Iterator	getIterator()
Integer	getMaxConcurrency()
String	getOutputPath()
String	getParameters()
String	getResultPath()
List<Retrier>	getRetriers()
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 MapState.

getTransition

public Transition getTransition()

Specified by:

getTransition in class TransitionState

Returns:

The transition that will occur when all branches have executed successfully.

getComment

public String getComment()

Returns:

Human readable description for the state.

getMaxConcurrency

public Integer getMaxConcurrency()

Returns:

Max Concurrency provides an upper bound on how many invocations of the Iterator may run in parallel

getIterator

public Iterator getIterator()

Returns:

The iterator for this MapState.

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.

getItemsPath

public String getItemsPath()

Returns:

The items path expression that is a reference path identifying where in the effective input the array field is found

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.

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 MapState.Builder builder()

Returns:

Builder instance to construct a MapState.