Class GetDocumentRequest (2.3.4)

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

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

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