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.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The parent resource name. In the format: |
↳ collection_id |
string
Optional. The collection ID, relative to |
↳ 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 |
↳ order_by |
string
Optional. The optional ordering of the documents to return. For example: |
↳ 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, |
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
Returns | |
---|---|
Type | Description |
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
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$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
.
Returns | |
---|---|
Type | Description |
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
.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getPageSize
Optional. The maximum number of documents to return in a single response.
Firestore may return fewer than this value.
Returns | |
---|---|
Type | Description |
int |
setPageSize
Optional. The maximum number of documents to return in a single response.
Firestore may return fewer than this value.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$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.
Returns | |
---|---|
Type | Description |
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.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$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
.
Returns | |
---|---|
Type | Description |
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
.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$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.
Returns | |
---|---|
Type | Description |
Google\Cloud\Firestore\V1\DocumentMask|null |
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.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Firestore\V1\DocumentMask
|
Returns | |
---|---|
Type | Description |
$this |
getTransaction
Perform the read as part of an already active transaction.
Returns | |
---|---|
Type | Description |
string |
hasTransaction
setTransaction
Perform the read as part of an already active transaction.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$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.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Timestamp|null |
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.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Timestamp
|
Returns | |
---|---|
Type | Description |
$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
.
Returns | |
---|---|
Type | Description |
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
.
Parameter | |
---|---|
Name | Description |
var |
bool
|
Returns | |
---|---|
Type | Description |
$this |
getConsistencySelector
Returns | |
---|---|
Type | Description |
string |