Reference documentation and code samples for the Cloud Firestore V1beta1 Client class ListDocumentsRequest.
The request for Firestore.ListDocuments.
Generated from protobuf message google.firestore.v1beta1.ListDocumentsRequest
Namespace
Google \ Cloud \ Firestore \ V1beta1Methods
__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
Required. The collection ID, relative to |
↳ page_size |
int
The maximum number of documents to return. |
↳ page_token |
string
The |
↳ order_by |
string
The order to sort results by. For example: |
↳ mask |
Google\Cloud\Firestore\V1beta1\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 |
string
Reads documents in a transaction. |
↳ read_time |
Google\Protobuf\Timestamp
Reads documents as they were at the given time. This may not be older than 60 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, or Document.update_time set. Requests with |
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
Required. The collection ID, relative to parent
, to list. For example: chatrooms
or messages
.
Returns | |
---|---|
Type | Description |
string |
setCollectionId
Required. The collection ID, relative to parent
, to list. For example: chatrooms
or messages
.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getPageSize
The maximum number of documents to return.
Returns | |
---|---|
Type | Description |
int |
setPageSize
The maximum number of documents to return.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getPageToken
The next_page_token
value returned from a previous List request, if any.
Returns | |
---|---|
Type | Description |
string |
setPageToken
The next_page_token
value returned from a previous List request, if any.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getOrderBy
The order to sort results by. For example: priority desc, name
.
Returns | |
---|---|
Type | Description |
string |
setOrderBy
The order to sort results by. For example: priority desc, name
.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getMask
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\V1beta1\DocumentMask |
setMask
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\V1beta1\DocumentMask
|
Returns | |
---|---|
Type | Description |
$this |
getTransaction
Reads documents in a transaction.
Returns | |
---|---|
Type | Description |
string |
setTransaction
Reads documents in a transaction.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getReadTime
Reads documents as they were at the given time.
This may not be older than 60 seconds.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Timestamp |
setReadTime
Reads documents as they were at the given time.
This may not be older than 60 seconds.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Timestamp
|
Returns | |
---|---|
Type | Description |
$this |
getShowMissing
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, or Document.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 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, or Document.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 |