com.amazonaws.services.stepfunctions.builder.states

Class Catcher.Builder

java.lang.Object

com.amazonaws.services.stepfunctions.builder.states.Catcher.Builder

All Implemented Interfaces:

Buildable<Catcher>, ResultPathBuilder<Catcher.Builder>

Enclosing class:

Catcher

public static final class Catcher.Builder
extends Object
implements Buildable<Catcher>, ResultPathBuilder<Catcher.Builder>

Builder for a Catcher.

Nested Class Summary

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

Buildable.Utils

Method Summary

Modifier and Type	Method and Description
Catcher	build()
Catcher.Builder	catchAll() Makes this catcher handle all errors.
Catcher.Builder	errorEquals(String... errorEquals) Adds to the error codes that this catcher handles.
Catcher.Builder	resultPath(String resultPath) OPTIONAL.
Catcher.Builder	transition(NextStateTransition.Builder transition) Sets the transition that will occur if this catcher is evaluated.

Methods inherited from class java.lang.Object

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

Method Detail

errorEquals

public Catcher.Builder errorEquals(String... errorEquals)

Adds to the error codes that this catcher handles. If the catcher matches an error code then the state machine transitions to the state identified by nextStateName(String).

Parameters:

errorEquals - New error codes to add to this catchers handled errors.

Returns:

This object for method chaining.

catchAll

public Catcher.Builder catchAll()

Makes this catcher handle all errors. This method should not be used with errorEquals.

Returns:

This object for method chaining.

resultPath

public Catcher.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<Catcher.Builder>

Parameters:

resultPath - 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.

Returns:

This object for method chaining.

transition

public Catcher.Builder transition(NextStateTransition.Builder transition)

Sets the transition that will occur if this catcher is evaluated. Currently only supports transitioning to another state.

Parameters:

transition - New transition.

Returns:

This object for method chaining.

build

public Catcher build()

Specified by:

build in interface Buildable<Catcher>

Returns:

An immutable Catcher object.