Class GetDocumentRequest (2.16.0)

Version latest

• 2.16.0 (latest)
• 2.15.0
• 2.14.0
• 2.13.1
• 2.12.0
• 2.11.1
• 2.10.1
• 2.9.1
• 2.8.0
• 2.7.3
• 2.6.1
• 2.5.3
• 2.4.0
• 2.3.4
• 2.2.0
• 2.1.3
• 2.0.2
• 1.9.2
• 1.8.1
• 1.7.0
• 1.6.2
• 1.5.0
• 1.4.0
• 1.3.0

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
Name	Description
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 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.