Retry: Retry base class

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

Description

A class for creating a Retry block

Super class

stepfunctions::Block -> Retry

Methods

Public methods

• Retry$new()

• Retry$allowed_fields()

• Retry$clone()

Inherited methods

• stepfunctions::Block$format()

• stepfunctions::Block$is_field_allowed()

• stepfunctions::Block$to_json()

• stepfunctions::Block$to_list()

---

Method new()

Initialize a Retry block.

Usage

Retry$new(
  error_equals,
  interval_seconds = NULL,
  max_attempts = NULL,
  backoff_rate = NULL,
  ...
)

Arguments

error_equals

(list(str)): Non-empty list of strings, which match Error Names https://states-language.net/spec.html#error-names. When a state reports an error, the interpreter scans through the retries and, when the Error Name appears in the value of a retrier’s 'error_equals' field, implements the retry policy described in that retrier.

interval_seconds

(int, optional): Positive integer representing the number of seconds before the first retry attempt. (default: 1)

max_attempts

(int, optional): Non-negative integer representing the maximum number of retry attempts. (default: 3)

backoff_rate

(float, optional): A number which is the multiplier that increases the retry interval on each attempt. (default: 2.0)

...

: Extra field names to pass to Block class

---

Method allowed_fields()

allowed extra fields

Usage

Retry$allowed_fields()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

Retry$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.