Fail: Fail State Class

In DyfanJones/aws-step-functions-data-science-sdk-r: R SDK for `AWS Stepfunctions`

Description

Fail State terminates the machine and marks it as a failure.

Super classes

stepfunctions::Block -> stepfunctions::State -> Fail

Methods

Public methods

• Fail$new()

• Fail$allowed_fields()

• Fail$clone()

Inherited methods

• stepfunctions::Block$is_field_allowed()

• stepfunctions::Block$to_json()

• stepfunctions::State$.next()

• stepfunctions::State$accept()

• stepfunctions::State$add_catch()

• stepfunctions::State$add_retry()

• stepfunctions::State$format()

• stepfunctions::State$output()

• stepfunctions::State$to_list()

• stepfunctions::State$update_parameters()

---

Method new()

Initialize Fail state class

Usage

Fail$new(state_id, error = NULL, cause = NULL, comment = NULL, ...)

Arguments

state_id

(str): State name whose length **must be** less than or equal to 128 unicode characters. State names **must be** unique within the scope of the whole state machine.

error

(str): Error name that can be used for error handling (retry/catch), operational, or diagnostic purposes.

cause

(str): Human-readable message describing the cause of the failure/error.

comment

(str, optional): Human-readable comment or description. (default: None).

...

: Extra field names to pass to Block class

---

Method allowed_fields()

allowed extra fields

Usage

Fail$allowed_fields()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

Fail$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

DyfanJones/aws-step-functions-data-science-sdk-r documentation built on Dec. 17, 2021, 5:31 p.m.