Method: indexes.patch

Full name: projects.locations.indexes.patch

Updates an Index.

Endpoint

patchhttps://{service-endpoint}/v1/{index.name}

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

Where{service-endpoint} is one of thesupported service endpoints.

Path parameters

index.namestring

Output only. The resource name of the Index.

Query parameters

updateMaskstring (FieldMask format)

The update mask applies to the resource. For theFieldMask definition, seegoogle.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 ofIndex.

Response body

If successful, the response body contains an instance ofOperation.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-06-27 UTC.