Struct RetryConfig 

#[non_exhaustive]
pub struct RetryConfig {
    pub max_attempts: i32,
    pub max_retry_duration: Option<Duration>,
    pub min_backoff: Option<Duration>,
    pub max_backoff: Option<Duration>,
    pub max_doublings: i32,
    /* private fields */
}

Retry config.

These settings determine when a failed task attempt is retried.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

max_attempts: i32

Number of attempts per task, including the first attempt. (If the first attempt fails, there will be max_attempts - 1 retries.)

Must be greater than or equal to -1, which indicates unlimited attempts.

Cloud Tasks stops retrying only when max_attempts and max_retry_duration are both satisfied, or when the task is successfully executed. When the task has been attempted max_attempts times and when the max_retry_duration time has passed, no further attempts are made, and the task is deleted. If max_attempts is set to -1 and max_retry_duration is set to 0, the task is retried until the maximum task retention limit is reached.

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

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

max_retry_duration: Option<Duration>

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 are made and the task is deleted.

A zero (0) indicates an unlimited duration, up to the maximum task retention limit.

The value must be given as a string that indicates the length of time (in seconds) followed by s (for “seconds”). For the maximum possible value or the format, see the documentation for Duration. max_retry_duration will be truncated to the nearest second.

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

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

min_backoff: Option<Duration>

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.

The value must be given as a string that indicates the length of time (in seconds) followed by s (for “seconds”). For more information on the format, see the documentation for Duration. min_backoff will be truncated to the nearest second.

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

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

max_backoff: Option<Duration>

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.

The value must be given as a string that indicates the length of time (in seconds) followed by s (for “seconds”). For more information on the format, see the documentation for Duration. max_backoff will be truncated to the nearest second.

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

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

max_doublings: 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 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 has the same meaning as max_doublings in queue.yaml/xml.

Implementations

impl RetryConfig

pub fn new() -> Self

Creates a new default instance.

pub fn set_max_attempts<T: Into<i32>>(self, v: T) -> Self

Sets the value of max_attempts.

Example

let x = RetryConfig::new().set_max_attempts(42);

pub fn set_max_retry_duration<T>(self, v: T) -> Self

where T: Into<Duration>,

Sets the value of max_retry_duration.

Example

use wkt::Duration;
let x = RetryConfig::new().set_max_retry_duration(Duration::default()/* use setters */);

pub fn set_or_clear_max_retry_duration<T>(self, v: Option<T>) -> Self

where T: Into<Duration>,

Sets or clears the value of max_retry_duration.

Example

use wkt::Duration;
let x = RetryConfig::new().set_or_clear_max_retry_duration(Some(Duration::default()/* use setters */));
let x = RetryConfig::new().set_or_clear_max_retry_duration(None::<Duration>);

pub fn set_min_backoff<T>(self, v: T) -> Self

where T: Into<Duration>,

Sets the value of min_backoff.

Example

use wkt::Duration;
let x = RetryConfig::new().set_min_backoff(Duration::default()/* use setters */);

pub fn set_or_clear_min_backoff<T>(self, v: Option<T>) -> Self

where T: Into<Duration>,

Sets or clears the value of min_backoff.

Example

use wkt::Duration;
let x = RetryConfig::new().set_or_clear_min_backoff(Some(Duration::default()/* use setters */));
let x = RetryConfig::new().set_or_clear_min_backoff(None::<Duration>);

pub fn set_max_backoff<T>(self, v: T) -> Self

where T: Into<Duration>,

Sets the value of max_backoff.

Example

use wkt::Duration;
let x = RetryConfig::new().set_max_backoff(Duration::default()/* use setters */);

pub fn set_or_clear_max_backoff<T>(self, v: Option<T>) -> Self

where T: Into<Duration>,

Sets or clears the value of max_backoff.

Example

use wkt::Duration;
let x = RetryConfig::new().set_or_clear_max_backoff(Some(Duration::default()/* use setters */));
let x = RetryConfig::new().set_or_clear_max_backoff(None::<Duration>);

pub fn set_max_doublings<T: Into<i32>>(self, v: T) -> Self

Sets the value of max_doublings.

Example

let x = RetryConfig::new().set_max_doublings(42);

Trait Implementations

impl Clone for RetryConfig

fn clone(&self) -> Self

Returns a duplicate 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() -> Self

Returns the “default value” for a type.

impl Message for RetryConfig

fn typename() -> &'static str

The typename of this message.

impl PartialEq for RetryConfig

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for RetryConfig