Struct RetryPolicy 

#[non_exhaustive]
pub struct RetryPolicy {
    pub minimum_backoff: Option<Duration>,
    pub maximum_backoff: Option<Duration>,
    /* private fields */
}

A policy that specifies how Pub/Sub retries message delivery.

Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff.

RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message.

Retry Policy is implemented on a best effort basis. At times, the delay between consecutive deliveries may not match the configuration. That is, delay can be more or less than configured backoff.

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.

minimum_backoff: Option<Duration>

Optional. The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.

maximum_backoff: Option<Duration>

Optional. The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds.

Implementations

impl RetryPolicy

pub fn new() -> Self

Creates a new default instance.

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

where T: Into<Duration>,

Sets the value of minimum_backoff.

Example

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

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

where T: Into<Duration>,

Sets or clears the value of minimum_backoff.

Example

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

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

where T: Into<Duration>,

Sets the value of maximum_backoff.

Example

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

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

where T: Into<Duration>,

Sets or clears the value of maximum_backoff.

Example

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

Trait Implementations

impl Clone for RetryPolicy

fn clone(&self) -> RetryPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RetryPolicy

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

Formats the value using the given formatter.

impl Default for RetryPolicy

fn default() -> RetryPolicy

Returns the “default value” for a type.

impl Message for RetryPolicy

fn typename() -> &'static str

The typename of this message.

impl PartialEq for RetryPolicy

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RetryPolicy