Class ListDocumentsRequest

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

Attributes
NameDescription
strparent
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``
strcollection_id
Required. The collection ID, relative to ``parent``, to list. For example: ``chatrooms`` or ``messages``.
intpage_size
The maximum number of documents to return.
strpage_token
The ``next_page_token`` value returned from a previous List request, if any.
strorder_by
The order to sort results by. For example: ``priority desc, name``.
google.cloud.firestore_v1.types.DocumentMaskmask
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.
bytestransaction
Reads documents in a transaction.
google.protobuf.timestamp_pb2.Timestampread_time
Reads documents as they were at the given time. This may not be older than 270 seconds.
boolshow_missing
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``.

Inheritance

builtins.object > proto.message.Message > ListDocumentsRequest