Method: projects.locations.indexes.patch

Updates an Index.

HTTP request

PATCH https://{service-endpoint}/v1/{index.name}

Where {service-endpoint} is one of the supported service endpoints.

Path parameters

Parameters
index.name

string

Output only. The resource name of the Index.

Query parameters

Parameters
updateMask

string (FieldMask format)

The update mask applies to the resource. For the FieldMask definition, see google.protobuf.FieldMask.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of Index.

Response body

If successful, the response body contains an instance of Operation.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • aiplatform.indexes.update

For more information, see the IAM documentation.