Class FailProps.Builder
java.lang.Object
software.amazon.awscdk.services.stepfunctions.FailProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<FailProps>
- Enclosing interface:
FailProps
@Stability(Stable)
public static final class FailProps.Builder
extends Object
implements software.amazon.jsii.Builder<FailProps>
A builder for
FailProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.Sets the value ofFailProps.getCause()
Sets the value ofFailProps.getCausePath()
Sets the value ofFailProps.getComment()
Sets the value ofFailProps.getError()
Sets the value ofFailProps.getErrorPath()
Sets the value ofFailProps.getStateName()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
cause
Sets the value ofFailProps.getCause()
- Parameters:
cause
- A description for the cause of the failure.- Returns:
this
-
causePath
Sets the value ofFailProps.getCausePath()
- Parameters:
causePath
- JsonPath expression to select part of the state to be the cause to this state. You can also use an intrinsic function that returns a string to specify this property. The allowed functions include States.Format, States.JsonToString, States.ArrayGetItem, States.Base64Encode, States.Base64Decode, States.Hash, and States.UUID.- Returns:
this
-
comment
Sets the value ofFailProps.getComment()
- Parameters:
comment
- An optional description for this state.- Returns:
this
-
error
Sets the value ofFailProps.getError()
- Parameters:
error
- Error code used to represent this failure.- Returns:
this
-
errorPath
Sets the value ofFailProps.getErrorPath()
- Parameters:
errorPath
- JsonPath expression to select part of the state to be the error to this state. You can also use an intrinsic function that returns a string to specify this property. The allowed functions include States.Format, States.JsonToString, States.ArrayGetItem, States.Base64Encode, States.Base64Decode, States.Hash, and States.UUID.- Returns:
this
-
stateName
Sets the value ofFailProps.getStateName()
- Parameters:
stateName
- Optional name for this state.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<FailProps>
- Returns:
- a new instance of
FailProps
- Throws:
NullPointerException
- if any required attribute was not provided
-