Cloud Firestore V1 API - Class Google::Cloud::Firestore::V1::Write (v0.10.0)

Reference documentation and code samples for the Cloud Firestore V1 API class Google::Cloud::Firestore::V1::Write.

A write on a document.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#current_document

def current_document() -> ::Google::Cloud::Firestore::V1::Precondition
Returns

#current_document=

def current_document=(value) -> ::Google::Cloud::Firestore::V1::Precondition
Parameter
Returns

#delete

def delete() -> ::String
Returns
  • (::String) — A document name to delete. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

#delete=

def delete=(value) -> ::String
Parameter
  • value (::String) — A document name to delete. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.
Returns
  • (::String) — A document name to delete. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

#transform

def transform() -> ::Google::Cloud::Firestore::V1::DocumentTransform
Returns

#transform=

def transform=(value) -> ::Google::Cloud::Firestore::V1::DocumentTransform
Parameter
Returns

#update

def update() -> ::Google::Cloud::Firestore::V1::Document
Returns

#update=

def update=(value) -> ::Google::Cloud::Firestore::V1::Document
Parameter
Returns

#update_mask

def update_mask() -> ::Google::Cloud::Firestore::V1::DocumentMask
Returns
  • (::Google::Cloud::Firestore::V1::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_mask=

def update_mask=(value) -> ::Google::Cloud::Firestore::V1::DocumentMask
Parameter
  • value (::Google::Cloud::Firestore::V1::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.

Returns
  • (::Google::Cloud::Firestore::V1::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

def update_transforms() -> ::Array<::Google::Cloud::Firestore::V1::DocumentTransform::FieldTransform>
Returns

#update_transforms=

def update_transforms=(value) -> ::Array<::Google::Cloud::Firestore::V1::DocumentTransform::FieldTransform>
Parameter
Returns