Class ListDocumentsRequest (2.3.4)

Version 2.3.4

• 2.16.0 (latest)
• 2.15.0
• 2.14.0
• 2.13.1
• 2.12.0
• 2.11.1
• 2.10.1
• 2.9.1
• 2.8.0
• 2.7.3
• 2.6.1
• 2.5.3
• 2.4.0
• 2.3.4
• 2.2.0
• 2.1.3
• 2.0.2
• 1.9.2
• 1.8.1
• 1.7.0
• 1.6.2
• 1.5.0
• 1.4.0
• 1.3.0

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

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

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.
read_time	google.protobuf.timestamp_pb2.Timestamp Reads documents as they were at the given time. This may not be older than 270 seconds.
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.