software.amazon.awscdk.services.stepfunctions

Interface FailProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

FailProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:55:48.156Z")
 @Stability(value=Experimental)
public interface FailProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties for defining a Fail state.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FailProps.Builder A builder for FailProps
static class	FailProps.Jsii$Proxy An implementation for FailProps

Method Summary

Modifier and Type	Method and Description
static FailProps.Builder	builder()
default String	getCause() (experimental) A description for the cause of the failure.
default String	getComment() (experimental) An optional description for this state.
default String	getError() (experimental) Error code used to represent this failure.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCause

@Stability(value=Experimental)
 @Nullable
default String getCause()

(experimental) A description for the cause of the failure.

Default: No description

getComment

@Stability(value=Experimental)
 @Nullable
default String getComment()

(experimental) An optional description for this state.

Default: No comment

getError

@Stability(value=Experimental)
 @Nullable
default String getError()

(experimental) Error code used to represent this failure.

Default: No error code

builder

@Stability(value=Experimental)
static FailProps.Builder builder()

Returns:

a FailProps.Builder of FailProps