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
Optional. The collection ID, relative to parent , to
list.
For example: chatrooms or messages .
This is optional, and when not provided, Firestore will list
documents from all collections under the provided
parent .
|
page_size |
int
Optional. The maximum number of documents to return in a single response. Firestore may return fewer than this value. |
page_token |
str
Optional. A page token, received from a previous ListDocuments response.
Provide this to retrieve the subsequent page. When
paginating, all other parameters (with the exception of
page_size ) must match the values set in the request that
generated the page token.
|
order_by |
str
Optional. The optional ordering of the documents to return. For example: priority desc, __name__ desc .
This mirrors the
[ORDER BY ][google.firestore.v1.StructuredQuery.order_by]
used in Firestore queries but in a string representation.
When absent, documents are ordered based on
__name__ ASC .
|
mask |
google.cloud.firestore_v1.types.DocumentMask
Optional. 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
Perform the read as part of an already active transaction. This field is a member of oneof _ consistency_selector .
|
read_time |
google.protobuf.timestamp_pb2.Timestamp
Perform the read at the provided time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. This field is a member of oneof _ consistency_selector .
|
show_missing |
bool
If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, [ create_time ][google.firestore.v1.Document.create_time],
or
[update_time ][google.firestore.v1.Document.update_time]
set.
Requests with show_missing may not specify where or
order_by .
|