Package software.amazon.awssdk.services.stepfunctions.builder.states

Class Catcher

java.lang.Object

software.amazon.awssdk.services.stepfunctions.builder.states.Catcher

public final class Catcher
extends Object

Catches an error from a ParallelState or a TaskState and transitions into the specified recovery state. The recovery state will receive the error output as input unless otherwise specified by a ResultPath.

See Also:

https://states-language.net/spec.html#errors

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static Catcher.Builder	builder()
List<String>	getErrorEquals()
String	getResultPath()
Transition	getTransition()

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static Catcher.Builder builder()

Returns:

Builder instance to construct a Catcher.

getErrorEquals

public List<String> getErrorEquals()

Returns:

List of error codes this catcher handles.

getResultPath

public String getResultPath()

Returns:

JSON Path expression that can be used to combine the error output with the input to the state. If not specified the result will solely consist of the error output. See https://states-language.net/spec.html#filters for more information.

getTransition

public Transition getTransition()

Returns:

The Transition that will occur if this catcher is evaluated (i.e. the error code matches a code in getErrorEquals().