Class: Google::Firestore::V1::Write
- Inherits:
-
Object
- Object
- Google::Firestore::V1::Write
- Defined in:
- lib/google/cloud/firestore/v1/doc/google/firestore/v1/write.rb
Overview
A write on a document.
Instance Attribute Summary collapse
-
#current_document ⇒ Google::Firestore::V1::Precondition
An optional precondition on the document.
-
#delete ⇒ String
A document name to delete.
-
#transform ⇒ Google::Firestore::V1::DocumentTransform
Applies a transformation to a document.
-
#update ⇒ Google::Firestore::V1::Document
A document to write.
-
#update_mask ⇒ Google::Firestore::V1::DocumentMask
The fields to update in this write.
-
#update_transforms ⇒ Array<Google::Firestore::V1::DocumentTransform::FieldTransform>
The transforms to perform after update.
Instance Attribute Details
#current_document ⇒ Google::Firestore::V1::Precondition
Returns An optional precondition on the document.
The write will fail if this is set and not met by the target document.
54 |
# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/write.rb', line 54 class Write; end |
#delete ⇒ String
Returns A document name to delete. In the format:
projects/{project_id}/databases/{database_id}/documents/{document_path}
.
54 |
# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/write.rb', line 54 class Write; end |
#transform ⇒ Google::Firestore::V1::DocumentTransform
Returns Applies a transformation to a document.
54 |
# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/write.rb', line 54 class Write; end |
#update ⇒ Google::Firestore::V1::Document
Returns A document to write.
54 |
# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/write.rb', line 54 class Write; end |
#update_mask ⇒ Google::Firestore::V1::DocumentMask
Returns 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.
54 |
# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/write.rb', line 54 class Write; end |
#update_transforms ⇒ Array<Google::Firestore::V1::DocumentTransform::FieldTransform>
Returns 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.
54 |
# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/write.rb', line 54 class Write; end |