Cloud Firestore V1 API - Class Google::Cloud::Firestore::V1::UpdateDocumentRequest (v0.12.0)

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

The request for Firestore.UpdateDocument.

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

#document

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

#document=

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

#mask

def mask() -> ::Google::Cloud::Firestore::V1::DocumentMask
Returns

#mask=

def mask=(value) -> ::Google::Cloud::Firestore::V1::DocumentMask
Parameter
  • value (::Google::Cloud::Firestore::V1::DocumentMask) — The fields to return. If not set, returns all fields.

    If the document has a field that is not present in this mask, that field will not be returned in the response.

Returns

#update_mask

def update_mask() -> ::Google::Cloud::Firestore::V1::DocumentMask
Returns
  • (::Google::Cloud::Firestore::V1::DocumentMask) — The fields to update. None of the field paths in the mask may contain a reserved name.

    If the document exists on the server and has fields not referenced in 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.

#update_mask=

def update_mask=(value) -> ::Google::Cloud::Firestore::V1::DocumentMask
Parameter
  • value (::Google::Cloud::Firestore::V1::DocumentMask) — The fields to update. None of the field paths in the mask may contain a reserved name.

    If the document exists on the server and has fields not referenced in 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.

Returns
  • (::Google::Cloud::Firestore::V1::DocumentMask) — The fields to update. None of the field paths in the mask may contain a reserved name.

    If the document exists on the server and has fields not referenced in 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.