Method: googleapis.firestore.v1beta1.projects.databases.indexes.list

Lists the indexes that match the specified filters.

Arguments

Parameters
parent

string

Required. The database name. For example: projects/{project_id}/databases/{database_id}

filter

string

(No description provided)

pageSize

integer (int32 format)

The standard List page size.

pageToken

string

The standard List page token.

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 GoogleFirestoreAdminV1beta1ListIndexesResponse.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- list:
    call: googleapis.firestore.v1beta1.projects.databases.indexes.list
    args:
        parent: ...
        filter: ...
        pageSize: ...
        pageToken: ...
    result: listResult

JSON

[
  {
    "list": {
      "call": "googleapis.firestore.v1beta1.projects.databases.indexes.list",
      "args": {
        "parent": "...",
        "filter": "...",
        "pageSize": "...",
        "pageToken": "..."
      },
      "result": "listResult"
    }
  }
]