Struct Modification 

#[non_exhaustive]
pub struct Modification {
    pub id: String,
    pub update_mask: Option<FieldMask>,
    pub mod: Option<Mod>,
    /* private fields */
}

A create, update, or delete of a particular column family.

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.

id: String

The ID of the column family to be modified.

update_mask: Option<FieldMask>

Optional. A mask specifying which fields (e.g. gc_rule) in the update mod should be updated, ignored for other modification types. If unset or empty, we treat it as updating gc_rule to be backward compatible.

mod: Option<Mod>

Column family modifications.

Implementations

impl Modification

pub fn new() -> Self

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

Sets the value of id.

Example

let x = Modification::new().set_id("example");

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

where T: Into<FieldMask>,

Sets the value of update_mask.

Example

use wkt::FieldMask;
let x = Modification::new().set_update_mask(FieldMask::default()/* use setters */);

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

where T: Into<FieldMask>,

Sets or clears the value of update_mask.

Example

use wkt::FieldMask;
let x = Modification::new().set_or_clear_update_mask(Some(FieldMask::default()/* use setters */));
let x = Modification::new().set_or_clear_update_mask(None::<FieldMask>);

pub fn set_mod<T: Into<Option<Mod>>>(self, v: T) -> Self

Sets the value of r#mod.

Note that all the setters affecting r#mod are mutually exclusive.

Example

use google_cloud_bigtable_admin_v2::model::modify_column_families_request::modification::Mod;
let x = Modification::new().set_mod(Some(Mod::Drop(true)));

pub fn create(&self) -> Option<&Box<ColumnFamily>>

The value of [r#mod][crate::model::modify_column_families_request::Modification::r#mod] if it holds a Create, None if the field is not set or holds a different branch.

pub fn set_create<T: Into<Box<ColumnFamily>>>(self, v: T) -> Self

Sets the value of [r#mod][crate::model::modify_column_families_request::Modification::r#mod] to hold a Create.

Note that all the setters affecting r#mod are mutually exclusive.

Example

use google_cloud_bigtable_admin_v2::model::ColumnFamily;
let x = Modification::new().set_create(ColumnFamily::default()/* use setters */);
assert!(x.create().is_some());
assert!(x.update().is_none());
assert!(x.drop().is_none());

pub fn update(&self) -> Option<&Box<ColumnFamily>>

The value of [r#mod][crate::model::modify_column_families_request::Modification::r#mod] if it holds a Update, None if the field is not set or holds a different branch.

pub fn set_update<T: Into<Box<ColumnFamily>>>(self, v: T) -> Self

Sets the value of [r#mod][crate::model::modify_column_families_request::Modification::r#mod] to hold a Update.

Note that all the setters affecting r#mod are mutually exclusive.

Example

use google_cloud_bigtable_admin_v2::model::ColumnFamily;
let x = Modification::new().set_update(ColumnFamily::default()/* use setters */);
assert!(x.update().is_some());
assert!(x.create().is_none());
assert!(x.drop().is_none());

pub fn drop(&self) -> Option<&bool>

The value of [r#mod][crate::model::modify_column_families_request::Modification::r#mod] if it holds a Drop, None if the field is not set or holds a different branch.

pub fn set_drop<T: Into<bool>>(self, v: T) -> Self

Sets the value of [r#mod][crate::model::modify_column_families_request::Modification::r#mod] to hold a Drop.

Note that all the setters affecting r#mod are mutually exclusive.

Example

let x = Modification::new().set_drop(true);
assert!(x.drop().is_some());
assert!(x.create().is_none());
assert!(x.update().is_none());

Trait Implementations

impl Clone for Modification

fn clone(&self) -> Modification

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Modification

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

Formats the value using the given formatter.

impl Default for Modification

fn default() -> Modification

Returns the “default value” for a type.

impl Message for Modification

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Modification

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