Struct Snapshot 

#[non_exhaustive]
pub struct Snapshot {
    pub name: String,
    pub topic: String,
    pub expire_time: Option<Timestamp>,
    pub labels: HashMap<String, String>,
    /* private fields */
}

A snapshot resource. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.

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.

name: String

Optional. The name of the snapshot.

topic: String

Optional. The name of the topic from which this snapshot is retaining messages.

expire_time: Option<Timestamp>

Optional. The snapshot is guaranteed to exist up until this time. A newly-created snapshot expires no later than 7 days from the time of its creation. Its exact lifetime is determined at creation by the existing backlog in the source subscription. Specifically, the lifetime of the snapshot is 7 days - (age of oldest unacked message in the subscription). For example, consider a subscription whose oldest unacked message is 3 days old. If a snapshot is created from this subscription, the snapshot – which will always capture this 3-day-old backlog as long as the snapshot exists – will expire in 4 days. The service will refuse to create a snapshot that would expire in less than 1 hour after creation.

labels: HashMap<String, String>

Optional. See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).

Implementations

impl Snapshot

pub fn new() -> Self

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

Sets the value of name.

Example

let x = Snapshot::new().set_name("example");

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

Sets the value of topic.

Example

let x = Snapshot::new().set_topic("example");

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

where T: Into<Timestamp>,

Sets the value of expire_time.

Example

use wkt::Timestamp;
let x = Snapshot::new().set_expire_time(Timestamp::default()/* use setters */);

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

where T: Into<Timestamp>,

Sets or clears the value of expire_time.

Example

use wkt::Timestamp;
let x = Snapshot::new().set_or_clear_expire_time(Some(Timestamp::default()/* use setters */));
let x = Snapshot::new().set_or_clear_expire_time(None::<Timestamp>);

pub fn set_labels<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of labels.

Example

let x = Snapshot::new().set_labels([
    ("key0", "abc"),
    ("key1", "xyz"),
]);

Trait Implementations

impl Clone for Snapshot

fn clone(&self) -> Snapshot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Snapshot

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

Formats the value using the given formatter.

impl Default for Snapshot

fn default() -> Snapshot

Returns the “default value” for a type.

impl Message for Snapshot

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Snapshot

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