Reference documentation and code samples for the Cloud Firestore V1 Client class ListCollectionIdsRequest.
The request for Firestore.ListCollectionIds.
Generated from protobuf message google.firestore.v1.ListCollectionIdsRequest
Namespace
Google \ Cloud \ Firestore \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The parent document. In the format: |
↳ page_size |
int
The maximum number of results to return. |
↳ page_token |
string
A page token. Must be a value from ListCollectionIdsResponse. |
↳ read_time |
Google\Protobuf\Timestamp
Reads documents as they were at the given time. This may not be older than 270 seconds. |
getParent
Required. The parent document. In the format:
projects/{project_id}/databases/{database_id}/documents/{document_path}.
For example:
projects/my-project/databases/my-database/documents/chatrooms/my-chatroom
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. The parent document. In the format:
projects/{project_id}/databases/{database_id}/documents/{document_path}.
For example:
projects/my-project/databases/my-database/documents/chatrooms/my-chatroom
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageSize
The maximum number of results to return.
| Returns | |
|---|---|
| Type | Description |
int | |
setPageSize
The maximum number of results to return.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageToken
A page token. Must be a value from ListCollectionIdsResponse.
| Returns | |
|---|---|
| Type | Description |
string | |
setPageToken
A page token. Must be a value from ListCollectionIdsResponse.
| 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 270 seconds.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasReadTime
setReadTime
Reads documents as they were at the given time.
This may not be older than 270 seconds.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getConsistencySelector
| Returns | |
|---|---|
| Type | Description |
string | |
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. The parent document. In the format:
|
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Firestore\V1\ListCollectionIdsRequest | |