Struct Write

pub struct Write {
    pub current_document: Option<Precondition>,
    pub delete: Option<String>,
    pub transform: Option<DocumentTransform>,
    pub update: Option<Document>,
    pub update_mask: Option<DocumentMask>,
    pub update_transforms: Option<Vec<FieldTransform>>,
}

A write on a document.

This type is not used in any activity, and only used as part of another schema.

Fields

current_document: Option<Precondition>

An optional precondition on the document. The write will fail if this is set and not met by the target document.

delete: Option<String>

A document name to delete. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

transform: Option<DocumentTransform>

Applies a transformation to a document.

update: Option<Document>

A document to write.

update_mask: Option<DocumentMask>

The fields to update in this write. This field can be set only when the operation is update. If the mask is not set for an update and the document exists, any existing data will be overwritten. If the mask is set and the document on the server has fields not covered by the mask, they are left unchanged. Fields referenced in the mask, but not present in the input document, are deleted from the document on the server. The field paths in this mask must not contain a reserved field name.

update_transforms: Option<Vec<FieldTransform>>

The transforms to perform after update. This field can be set only when the operation is update. If present, this write is equivalent to performing update and transform to the same document atomically and in order.

Trait Implementations

impl Clone for Write

fn clone(&self) -> Write

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Write

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

Formats the value using the given formatter.

impl Default for Write

fn default() -> Write

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Write

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Write

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Part for Write