Interface FailProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
FailProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-12-06T14:43:27.721Z")
@Stability(Stable)
public interface FailProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a Fail state.
Example:
Fail fail = Fail.Builder.create(this, "Fail") .errorPath(JsonPath.format("error: {}.", JsonPath.stringAt("$.someError"))) .causePath("States.Format('cause: {}.', $.someCause)") .build();
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic FailProps.Builder
builder()
default String
getCause()
A description for the cause of the failure.default String
JsonPath expression to select part of the state to be the cause to this state.default String
An optional description for this state.default String
getError()
Error code used to represent this failure.default String
JsonPath expression to select part of the state to be the error to this state.default String
Optional name for this state.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getCause
A description for the cause of the failure.Default: - No description
-
getCausePath
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.
Default: - No cause path
-
getComment
An optional description for this state.Default: - No comment
-
getError
Error code used to represent this failure.Default: - No error code
-
getErrorPath
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.
Default: - No error path
-
getStateName
Optional name for this state.Default: - The construct ID will be used as state name
-
builder
- Returns:
- a
FailProps.Builder
ofFailProps
-