Class BatchGetDocumentsRequest (2.9.1)

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

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

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:


database str
Required. The database name. In the format: projects/{project_id}/databases/{database_id}.
documents MutableSequence[str]
The names of the documents to retrieve. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}. The request will fail if any of the document is not a child resource of the given database. Duplicate names will be elided.
The fields to return. If not set, returns all fields. If a document has a field that is not present in this mask, that field will not be returned in the response.
transaction bytes
Reads documents in a transaction. This field is a member of oneof_ consistency_selector.
Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream. This field is a member of oneof_ consistency_selector.
read_time google.protobuf.timestamp_pb2.Timestamp
Reads documents as they were at the given time. This may not be older than 270 seconds. This field is a member of oneof_ consistency_selector.