Class GetDocumentRequest (2.5.3)

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

The request for Firestore.GetDocument][google.firestore.v1.Firestore.GetDocument].

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
name str
Required. The resource name of the Document to get. In the format: ``projects/{project_id}/databases/{database_id}/documents/{document_path}``.
mask google.cloud.firestore_v1.types.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.
transaction bytes
Reads the document in a transaction. This field is a member of `oneof`_ ``consistency_selector``.
read_time google.protobuf.timestamp_pb2.Timestamp
Reads the version of the document at the given time. This may not be older than 270 seconds. This field is a member of `oneof`_ ``consistency_selector``.

Inheritance

builtins.object > proto.message.Message > GetDocumentRequest