Class Write (2.5.3)

Write(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A write on a document.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

NameDescription
update google.cloud.firestore_v1.types.Document
A document to write. This field is a member of `oneof`_ ``operation``.
delete str
A document name to delete. In the format: ``projects/{project_id}/databases/{database_id}/documents/{document_path}``. This field is a member of `oneof`_ ``operation``.
transform google.cloud.firestore_v1.types.DocumentTransform
Applies a transformation to a document. This field is a member of `oneof`_ ``operation``.
update_mask google.cloud.firestore_v1.types.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 Sequence[google.cloud.firestore_v1.types.DocumentTransform.FieldTransform]
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.
current_document google.cloud.firestore_v1.types.Precondition
An optional precondition on the document. The write will fail if this is set and not met by the target document.

Inheritance

builtins.object > proto.message.Message > Write