Struct google_cloudtasks2_beta2::RetryConfig

pub struct RetryConfig {
    pub max_attempts: Option<i32>,
    pub max_retry_duration: Option<String>,
    pub min_backoff: Option<String>,
    pub max_doublings: Option<i32>,
    pub max_backoff: Option<String>,
    pub unlimited_attempts: Option<bool>,
}

Retry config.

These settings determine how a failed task attempt is retried.

This type is not used in any activity, and only used as part of another schema.

Fields

max_attempts: Option<i32>

The maximum number of attempts for a task.

Cloud Tasks will attempt the task max_attempts times (that is, if the first attempt fails, then there will be max_attempts - 1 retries). Must be > 0.

max_retry_duration: Option<String>

If positive, max_retry_duration specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once max_retry_duration time has passed and the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted.

If zero, then the task age is unlimited.

If unspecified when the queue is created, Cloud Tasks will pick the default.

This field is output only for pull queues.

max_retry_duration will be truncated to the nearest second.

This field has the same meaning as task_age_limit in queue.yaml/xml.

min_backoff: Option<String>

A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue’s RetryConfig specifies that the task should be retried.

If unspecified when the queue is created, Cloud Tasks will pick the default.

This field is output only for pull queues.

min_backoff will be truncated to the nearest second.

This field has the same meaning as min_backoff_seconds in queue.yaml/xml.

max_doublings: Option<i32>

The time between retries will double max_doublings times.

A task’s retry interval starts at min_backoff, then doubles max_doublings times, then increases linearly, and finally retries retries at intervals of max_backoff up to max_attempts times.

For example, if min_backoff is 10s, max_backoff is 300s, and max_doublings is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ….

If unspecified when the queue is created, Cloud Tasks will pick the default.

This field is output only for pull queues.

This field has the same meaning as max_doublings in queue.yaml/xml.

max_backoff: Option<String>

A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue’s RetryConfig specifies that the task should be retried.

If unspecified when the queue is created, Cloud Tasks will pick the default.

This field is output only for pull queues.

max_backoff will be truncated to the nearest second.

This field has the same meaning as max_backoff_seconds in queue.yaml/xml.

unlimited_attempts: Option<bool>

If true, then the number of attempts is unlimited.

Trait Implementations

impl Clone for RetryConfig

fn clone(&self) -> RetryConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RetryConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RetryConfig

fn default() -> RetryConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RetryConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RetryConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Part for RetryConfig