Lists composite indexes.
Arguments
Parameters | |
---|---|
parent |
Required. A parent name of the form
|
filter |
The filter to apply to list results.
|
pageSize |
The number of results to return.
|
pageToken |
A page token, returned from a previous call to FirestoreAdmin.ListIndexes, that may be used to get the next page of results.
|
Raised exceptions
Exceptions | |
---|---|
ConnectionError |
In case of a network problem (such as DNS failure or refused connection). |
HttpError |
If the response status is >= 400 (excluding 429 and 503). |
TimeoutError |
If a long-running operation takes longer to finish than the specified timeout limit. |
TypeError |
If an operation or function receives an argument of the wrong type. |
ValueError |
If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout. |
Response
If successful, the response contains an instance of GoogleFirestoreAdminV1ListIndexesResponse
.
Subworkflow snippet
Some fields might be optional or required. To identify required fields, refer to the API documentation.
YAML
- list: call: googleapis.firestore.v1.projects.databases.collectionGroups.indexes.list args: parent: ... filter: ... pageSize: ... pageToken: ... result: listResult
JSON
[ { "list": { "call": "googleapis.firestore.v1.projects.databases.collectionGroups.indexes.list", "args": { "parent": "...", "filter": "...", "pageSize": "...", "pageToken": "..." }, "result": "listResult" } } ]