RetryPolicy: RetryPolicy base class

In DyfanJones/sagemaker-r-workflow: sagemaker pipeline and workflows

RetryPolicy base class

Description

RetryPolicy base class

RetryPolicy base class

Super class

sagemaker.workflow::Entity -> RetryPolicy

Public fields

backoff_rate

(float): The multiplier by which the retry interval increases during each attempt (default: 2.0)

interval_seconds

(int): An integer that represents the number of seconds before the first retry attempt (default: 1)

max_attempts

(int): A positive integer that represents the maximum number of retry attempts. (default: None)

expire_after_mins

(int): A positive integer that represents the maximum minute to expire any further retry attempt (default: None)

Methods

Public methods

• RetryPolicy$new()

• RetryPolicy$validate_backoff_rate()

• RetryPolicy$validate_interval_seconds()

• RetryPolicy$validate_max_attempts()

• RetryPolicy$validate_expire_after_mins()

• RetryPolicy$to_request()

• RetryPolicy$format()

• RetryPolicy$clone()

Inherited methods

---

Method new()

Initialize RetryPolicy class

Usage

RetryPolicy$new(
  backoff_rate = DEFAULT_BACKOFF_RATE,
  interval_seconds = DEFAULT_INTERVAL_SECONDS,
  max_attempts = NULL,
  expire_after_mins = NULL
)

Arguments

backoff_rate

(float): The multiplier by which the retry interval increases during each attempt (default: 2.0)

interval_seconds

(int): An integer that represents the number of seconds before the first retry attempt (default: 1)

max_attempts

(int): A positive integer that represents the maximum number of retry attempts. (default: None)

expire_after_mins

(int): A positive integer that represents the maximum minute to expire any further retry attempt (default: None)

---

Method validate_backoff_rate()

Validate the input back off rate type

Usage

RetryPolicy$validate_backoff_rate(value)

Arguments

value

object to be checked

---

Method validate_interval_seconds()

Validate the input interval seconds

Usage

RetryPolicy$validate_interval_seconds(value)

Arguments

value

object to be checked

---

Method validate_max_attempts()

Validate the input max attempts

Usage

RetryPolicy$validate_max_attempts(value)

Arguments

value

object to be checked

---

Method validate_expire_after_mins()

Validate expire after mins

Usage

RetryPolicy$validate_expire_after_mins(value)

Arguments

value

object to be checked

---

Method to_request()

Get the request structure for workflow service calls.

Usage

RetryPolicy$to_request()

Arguments

value

object to be checked

---

Method format()

format class

Usage

RetryPolicy$format()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

RetryPolicy$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

DyfanJones/sagemaker-r-workflow documentation built on April 3, 2022, 11:28 p.m.