Struct UpdateFieldRequest 

#[non_exhaustive]
pub struct UpdateFieldRequest {
    pub field: Option<Field>,
    pub update_mask: Option<FieldMask>,
    /* private fields */
}

The request for FirestoreAdmin.UpdateField.

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.

field: Option<Field>

Required. The field to be updated.

update_mask: Option<FieldMask>

A mask, relative to the field. If specified, only configuration specified by this field_mask will be updated in the field.

Implementations

impl UpdateFieldRequest

pub fn new() -> Self

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

where T: Into<Field>,

Sets the value of field.

Example

use google_cloud_firestore_admin_v1::model::Field;
let x = UpdateFieldRequest::new().set_field(Field::default()/* use setters */);

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

where T: Into<Field>,

Sets or clears the value of field.

Example

use google_cloud_firestore_admin_v1::model::Field;
let x = UpdateFieldRequest::new().set_or_clear_field(Some(Field::default()/* use setters */));
let x = UpdateFieldRequest::new().set_or_clear_field(None::<Field>);

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

Trait Implementations

impl Clone for UpdateFieldRequest

fn clone(&self) -> UpdateFieldRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateFieldRequest

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

Formats the value using the given formatter.

impl Default for UpdateFieldRequest

fn default() -> UpdateFieldRequest

Returns the “default value” for a type.

impl Message for UpdateFieldRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for UpdateFieldRequest

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