ListDocumentsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The request for
Firestore.ListDocuments][google.firestore.v1.Firestore.ListDocuments]
.
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 |
parent |
str
Required. The parent resource name. In the format: ``projects/{project_id}/databases/{database_id}/documents`` or ``projects/{project_id}/databases/{database_id}/documents/{document_path}``. For example: ``projects/my-project/databases/my-database/documents`` or ``projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`` |
collection_id |
str
Required. The collection ID, relative to ``parent``, to list. For example: ``chatrooms`` or ``messages``. |
page_size |
int
The maximum number of documents to return. |
page_token |
str
The ``next_page_token`` value returned from a previous List request, if any. |
order_by |
str
The order to sort results by. For example: ``priority desc, name``. |
mask |
google.cloud.firestore_v1.types.DocumentMask
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``. |
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``. |
show_missing |
bool
If the list should show missing documents. A missing document is a document that does not exist but has sub-documents. These documents will be returned with a key but will not have fields, `Document.create_time][google.firestore.v1.Document.create_time]`, or `Document.update_time][google.firestore.v1.Document.update_time]` set. Requests with ``show_missing`` may not specify ``where`` or ``order_by``. |