Reference documentation and code samples for the Cloud Firestore V1 Client class ListIndexesRequest.
The request for FirestoreAdmin.ListIndexes.
Generated from protobuf message google.firestore.admin.v1.ListIndexesRequest
Namespace
Google \ Cloud \ Firestore \ Admin \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. A parent name of the form |
↳ filter |
string
The filter to apply to list results. |
↳ page_size |
int
The number of results to return. |
↳ page_token |
string
A page token, returned from a previous call to FirestoreAdmin.ListIndexes, that may be used to get the next page of results. |
getParent
Required. A parent name of the form
projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. A parent name of the form
projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFilter
The filter to apply to list results.
| Returns | |
|---|---|
| Type | Description |
string |
|
setFilter
The filter to apply to list results.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
The number of results to return.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPageSize
The number of results to return.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageToken
A page token, returned from a previous call to FirestoreAdmin.ListIndexes, that may be used to get the next page of results.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
A page token, returned from a previous call to FirestoreAdmin.ListIndexes, that may be used to get the next page of results.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. A parent name of the form
|
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Firestore\Admin\V1\ListIndexesRequest |
|