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- (::Google::Cloud::Firestore::V1::Precondition) — An optional precondition on the document. The request will fail if this is set and not met by the target document.
#current_document=
def current_document=(value) -> ::Google::Cloud::Firestore::V1::Precondition- value (::Google::Cloud::Firestore::V1::Precondition) — An optional precondition on the document. The request will fail if this is set and not met by the target document.
- (::Google::Cloud::Firestore::V1::Precondition) — An optional precondition on the document. The request will fail if this is set and not met by the target document.
#document
def document() -> ::Google::Cloud::Firestore::V1::Document- (::Google::Cloud::Firestore::V1::Document) — Required. The updated document. Creates the document if it does not already exist.
#document=
def document=(value) -> ::Google::Cloud::Firestore::V1::Document- value (::Google::Cloud::Firestore::V1::Document) — Required. The updated document. Creates the document if it does not already exist.
- (::Google::Cloud::Firestore::V1::Document) — Required. The updated document. Creates the document if it does not already exist.
#mask
def mask() -> ::Google::Cloud::Firestore::V1::DocumentMask-
(::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.
#mask=
def mask=(value) -> ::Google::Cloud::Firestore::V1::DocumentMask-
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.
-
(::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.
#update_mask
def update_mask() -> ::Google::Cloud::Firestore::V1::DocumentMask-
(::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-
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.
-
(::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.