Struct SnapshotTableRequest 

#[non_exhaustive]
pub struct SnapshotTableRequest {
    pub name: String,
    pub cluster: String,
    pub snapshot_id: String,
    pub ttl: Option<Duration>,
    pub description: String,
    /* private fields */
}

Request message for google.bigtable.admin.v2.BigtableTableAdmin.SnapshotTable

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

Required. The unique name of the table to have the snapshot taken. Values are of the form projects/{project}/instances/{instance}/tables/{table}.

cluster: String

Required. The name of the cluster where the snapshot will be created in. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}.

snapshot_id: String

Required. The ID by which the new snapshot should be referred to within the parent cluster, e.g., mysnapshot of the form: [_a-zA-Z0-9][-_.a-zA-Z0-9]* rather than projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/mysnapshot.

ttl: Option<Duration>

The amount of time that the new snapshot can stay active after it is created. Once ‘ttl’ expires, the snapshot will get deleted. The maximum amount of time a snapshot can stay active is 7 days. If ‘ttl’ is not specified, the default value of 24 hours will be used.

description: String

Description of the snapshot.

Implementations

impl SnapshotTableRequest

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 = SnapshotTableRequest::new().set_name(format!("projects/{project_id}/instances/{instance_id}/tables/{table_id}"));

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

Sets the value of cluster.

Example

let x = SnapshotTableRequest::new().set_cluster(format!("projects/{project_id}/instances/{instance_id}/clusters/{cluster_id}"));

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

Sets the value of snapshot_id.

Example

let x = SnapshotTableRequest::new().set_snapshot_id("example");

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

where T: Into<Duration>,

Sets the value of ttl.

Example

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

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

where T: Into<Duration>,

Sets or clears the value of ttl.

Example

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

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

Sets the value of description.

Example

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

Trait Implementations

impl Clone for SnapshotTableRequest

fn clone(&self) -> SnapshotTableRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SnapshotTableRequest

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

Formats the value using the given formatter.

impl Default for SnapshotTableRequest

fn default() -> SnapshotTableRequest

Returns the “default value” for a type.

impl Message for SnapshotTableRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for SnapshotTableRequest

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SnapshotTableRequest