Struct Snapshot 

#[non_exhaustive]
pub struct Snapshot {
    pub name: String,
    pub source_table: Option<Table>,
    pub data_size_bytes: i64,
    pub create_time: Option<Timestamp>,
    pub delete_time: Option<Timestamp>,
    pub state: State,
    pub description: String,
    /* private fields */
}

A snapshot of a table at a particular time. A snapshot can be used as a checkpoint for data restoration or a data source for a new table.

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

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

The unique name of the snapshot. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}.

source_table: Option<Table>

Output only. The source table at the time the snapshot was taken.

data_size_bytes: i64

Output only. The size of the data in the source table at the time the snapshot was taken. In some cases, this value may be computed asynchronously via a background process and a placeholder of 0 will be used in the meantime.

create_time: Option<Timestamp>

Output only. The time when the snapshot is created.

delete_time: Option<Timestamp>

The time when the snapshot will be deleted. The maximum amount of time a snapshot can stay active is 365 days. If ‘ttl’ is not specified, the default maximum of 365 days will be used.

state: State

Output only. The current state of the snapshot.

description: String

Description of the snapshot.

Implementations

impl Snapshot

pub fn new() -> Self

Creates a new default instance.

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

Sets the value of name.

Example

let x = Snapshot::new().set_name(format!("projects/{project_id}/instances/{instance_id}/clusters/{cluster_id}/snapshots/{snapshot_id}"));

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

where T: Into<Table>,

Sets the value of source_table.

Example

use google_cloud_bigtable_admin_v2::model::Table;
let x = Snapshot::new().set_source_table(Table::default()/* use setters */);

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

where T: Into<Table>,

Sets or clears the value of source_table.

Example

use google_cloud_bigtable_admin_v2::model::Table;
let x = Snapshot::new().set_or_clear_source_table(Some(Table::default()/* use setters */));
let x = Snapshot::new().set_or_clear_source_table(None::<Table>);

pub fn set_data_size_bytes<T: Into<i64>>(self, v: T) -> Self

Sets the value of data_size_bytes.

Example

let x = Snapshot::new().set_data_size_bytes(42);

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

where T: Into<Timestamp>,

Sets the value of create_time.

Example

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

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

where T: Into<Timestamp>,

Sets or clears the value of create_time.

Example

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

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

where T: Into<Timestamp>,

Sets the value of delete_time.

Example

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

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

where T: Into<Timestamp>,

Sets or clears the value of delete_time.

Example

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

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

Sets the value of state.

Example

use google_cloud_bigtable_admin_v2::model::snapshot::State;
let x0 = Snapshot::new().set_state(State::Ready);
let x1 = Snapshot::new().set_state(State::Creating);

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

Sets the value of description.

Example

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

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Snapshot