Struct DeadLetterPolicy 

#[non_exhaustive]
pub struct DeadLetterPolicy {
    pub dead_letter_topic: String,
    pub max_delivery_attempts: i32,
    /* private fields */
}

Dead lettering is done on a best effort basis. The same message might be dead lettered multiple times.

If validation on any of the fields fails at subscription creation/updation, the create/update subscription request will fail.

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.

dead_letter_topic: String

Optional. The name of the topic to which dead letter messages should be published. Format is projects/{project}/topics/{topic}.The Pub/Sub service account associated with the enclosing subscription’s parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Publish() to this topic.

The operation will fail if the topic does not exist. Users should ensure that there is a subscription attached to this topic since messages published to a topic with no subscriptions are lost.

max_delivery_attempts: i32

Optional. The maximum number of delivery attempts for any message. The value must be between 5 and 100.

The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgement deadline has been exceeded for the message).

A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack_deadlines.

This field will be honored on a best effort basis.

If this parameter is 0, a default value of 5 is used.

Implementations

impl DeadLetterPolicy

pub fn new() -> Self

Creates a new default instance.

pub fn set_dead_letter_topic<T: Into<String>>(self, v: T) -> Self

Sets the value of dead_letter_topic.

Example

let x = DeadLetterPolicy::new().set_dead_letter_topic("example");

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

Sets the value of max_delivery_attempts.

Example

let x = DeadLetterPolicy::new().set_max_delivery_attempts(42);

Trait Implementations

impl Clone for DeadLetterPolicy

fn clone(&self) -> DeadLetterPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DeadLetterPolicy

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

Formats the value using the given formatter.

impl Default for DeadLetterPolicy

fn default() -> DeadLetterPolicy

Returns the “default value” for a type.

impl Message for DeadLetterPolicy

fn typename() -> &'static str

The typename of this message.

impl PartialEq for DeadLetterPolicy

fn eq(&self, other: &DeadLetterPolicy) -> 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 DeadLetterPolicy