Reference documentation and code samples for the Cloud Firestore V1 Client class ListDocumentsRequest.
The request for Firestore.ListDocuments .
Generated from protobuf message google.firestore.v1.ListDocumentsRequest
Namespace
Google \ Cloud \ Firestore \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ parent
string
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
string
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
string
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
string
Optional. The optional ordering of the documents to return. For example: priority desc, __name__ desc
. This mirrors the 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\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
string
Perform the read as part of an already active transaction.
↳ read_time
Google\Protobuf\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.
↳ 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
, or update_time
set. Requests with show_missing
may not specify where
or order_by
.
getParent
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
string
setParent
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
var
string
$this
getCollectionId
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
.
string
setCollectionId
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
.
var
string
$this
getPageSize
Optional. The maximum number of documents to return in a single response.
Firestore may return fewer than this value.
int
setPageSize
Optional. The maximum number of documents to return in a single response.
Firestore may return fewer than this value.
var
int
$this
getPageToken
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.
string
setPageToken
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.
var
string
$this
getOrderBy
Optional. The optional ordering of the documents to return.
For example: priority desc, __name__ desc
.
This mirrors the ORDER BY
used in Firestore queries but in a string representation. When absent,
documents are ordered based on __name__ ASC
.
string
setOrderBy
Optional. The optional ordering of the documents to return.
For example: priority desc, __name__ desc
.
This mirrors the ORDER BY
used in Firestore queries but in a string representation. When absent,
documents are ordered based on __name__ ASC
.
var
string
$this
getMask
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.
hasMask
clearMask
setMask
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.
$this
getTransaction
Perform the read as part of an already active transaction.
string
hasTransaction
setTransaction
Perform the read as part of an already active transaction.
var
string
$this
getReadTime
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.
hasReadTime
setReadTime
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
getShowMissing
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
, or update_time
set.
Requests with show_missing
may not specify where
or order_by
.
bool
setShowMissing
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
, or update_time
set.
Requests with show_missing
may not specify where
or order_by
.
var
bool
$this
getConsistencySelector
string
