Method: googleapis.firestore.v1beta2.projects.databases.collectionGroups.indexes.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists composite indexes.
Arguments
Parameters |
parent |
string
Required. A parent name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
|
filter |
string
The filter to apply to list results.
|
pageSize |
integer (int32 format)
The number of results to return.
|
pageToken |
string
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 GoogleFirestoreAdminV1beta2ListIndexesResponse
.
Subworkflow snippet
Some fields might be optional or required.
To identify required fields, refer to the API documentation.
YAML
- list:
call: googleapis.firestore.v1beta2.projects.databases.collectionGroups.indexes.list
args:
parent: ...
filter: ...
pageSize: ...
pageToken: ...
result: listResult
JSON
[
{
"list": {
"call": "googleapis.firestore.v1beta2.projects.databases.collectionGroups.indexes.list",
"args": {
"parent": "...",
"filter": "...",
"pageSize": "...",
"pageToken": "..."
},
"result": "listResult"
}
}
]
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-01 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
{"lastModified": "Last updated 2024-10-01 UTC."}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-01 UTC."]]