Class GetDocumentRequest (2.14.0rc1)

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:


name str
Required. The resource name of the Document to get. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.
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 must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. This field is a member of oneof_ consistency_selector.