Class: Google::Firestore::V1beta1::UpdateDocumentRequest
- Inherits:
-
Object
- Object
- Google::Firestore::V1beta1::UpdateDocumentRequest
- Defined in:
- lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/firestore.rb
Overview
The request for Firestore::UpdateDocument.
Instance Attribute Summary collapse
-
#current_document ⇒ Google::Firestore::V1beta1::Precondition
An optional precondition on the document.
-
#document ⇒ Google::Firestore::V1beta1::Document
Required.
-
#mask ⇒ Google::Firestore::V1beta1::DocumentMask
The fields to return.
-
#update_mask ⇒ Google::Firestore::V1beta1::DocumentMask
The fields to update.
Instance Attribute Details
#current_document ⇒ Google::Firestore::V1beta1::Precondition
Returns An optional precondition on the document. The request will fail if this is set and not met by the target document.
143 |
# File 'lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/firestore.rb', line 143 class UpdateDocumentRequest; end |
#document ⇒ Google::Firestore::V1beta1::Document
Returns Required. The updated document. Creates the document if it does not already exist.
143 |
# File 'lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/firestore.rb', line 143 class UpdateDocumentRequest; end |
#mask ⇒ Google::Firestore::V1beta1::DocumentMask
Returns 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.
143 |
# File 'lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/firestore.rb', line 143 class UpdateDocumentRequest; end |
#update_mask ⇒ Google::Firestore::V1beta1::DocumentMask
Returns 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.
143 |
# File 'lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/firestore.rb', line 143 class UpdateDocumentRequest; end |