Method: googleapis.firestore.v1beta2.projects.databases.collectionGroups.indexes.delete

Deletes a composite index.

Arguments

Parameters
name

string

Required. A name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

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 will be empty.

Subworkflow snippet

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

YAML

- delete:
    call: googleapis.firestore.v1beta2.projects.databases.collectionGroups.indexes.delete
    args:
        name: ...
    result: deleteResult

JSON

[
  {
    "delete": {
      "call": "googleapis.firestore.v1beta2.projects.databases.collectionGroups.indexes.delete",
      "args": {
        "name": "..."
      },
      "result": "deleteResult"
    }
  }
]