Class BatchGetDocumentsResponse (2.6.0)

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

The streamed response 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: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

NameDescription
found google.cloud.firestore_v1.types.Document
A document that was requested. This field is a member of `oneof`_ ``result``.
missing str
A document name that was requested but does not exist. In the format: ``projects/{project_id}/databases/{database_id}/documents/{document_path}``. This field is a member of `oneof`_ ``result``.
transaction bytes
The transaction that was started as part of this request. Will only be set in the first response, and only if `BatchGetDocumentsRequest.new_transaction][google.firestore.v1.BatchGetDocumentsRequest.new_transaction]` was set in the request.
read_time google.protobuf.timestamp_pb2.Timestamp
The time at which the document was read. This may be monotically increasing, in this case the previous documents in the result stream are guaranteed not to have changed between their read_time and this one.

Inheritance

builtins.object > proto.message.Message > BatchGetDocumentsResponse