Struct Backup 

#[non_exhaustive]
pub struct Backup {
    pub name: String,
    pub database: String,
    pub database_uid: String,
    pub snapshot_time: Option<Timestamp>,
    pub expire_time: Option<Timestamp>,
    pub stats: Option<Stats>,
    pub state: State,
    /* private fields */
}

A Backup of a Cloud Firestore Database.

The backup contains all documents and index configurations for the given database at a specific point in time.

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

Output only. The unique resource name of the Backup.

Format is projects/{project}/locations/{location}/backups/{backup}.

database: String

Output only. Name of the Firestore database that the backup is from.

Format is projects/{project}/databases/{database}.

database_uid: String

Output only. The system-generated UUID4 for the Firestore database that the backup is from.

snapshot_time: Option<Timestamp>

Output only. The backup contains an externally consistent copy of the database at this time.

expire_time: Option<Timestamp>

Output only. The timestamp at which this backup expires.

stats: Option<Stats>

Output only. Statistics about the backup.

This data only becomes available after the backup is fully materialized to secondary storage. This field will be empty till then.

state: State

Output only. The current state of the backup.

Implementations

impl Backup

pub fn new() -> Self

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

Sets the value of name.

Example

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

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

Sets the value of database.

Example

let x = Backup::new().set_database("example");

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

Sets the value of database_uid.

Example

let x = Backup::new().set_database_uid("example");

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

where T: Into<Timestamp>,

Sets the value of snapshot_time.

Example

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

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

where T: Into<Timestamp>,

Sets or clears the value of snapshot_time.

Example

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

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 = Backup::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 = Backup::new().set_or_clear_expire_time(Some(Timestamp::default()/* use setters */));
let x = Backup::new().set_or_clear_expire_time(None::<Timestamp>);

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

where T: Into<Stats>,

Sets the value of stats.

Example

use google_cloud_firestore_admin_v1::model::backup::Stats;
let x = Backup::new().set_stats(Stats::default()/* use setters */);

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

where T: Into<Stats>,

Sets or clears the value of stats.

Example

use google_cloud_firestore_admin_v1::model::backup::Stats;
let x = Backup::new().set_or_clear_stats(Some(Stats::default()/* use setters */));
let x = Backup::new().set_or_clear_stats(None::<Stats>);

pub fn set_state<T: Into<State>>(self, v: T) -> Self

Sets the value of state.

Example

use google_cloud_firestore_admin_v1::model::backup::State;
let x0 = Backup::new().set_state(State::Creating);
let x1 = Backup::new().set_state(State::Ready);
let x2 = Backup::new().set_state(State::NotAvailable);

Trait Implementations

impl Clone for Backup

fn clone(&self) -> Backup

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Backup

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

Formats the value using the given formatter.

impl Default for Backup

fn default() -> Backup

Returns the “default value” for a type.

impl Message for Backup

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Backup

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