Method: projects.locations.indexEndpoints.patch

Updates an IndexEndpoint.

HTTP request

PATCH https://visionai.googleapis.com/v1alpha1/{indexEndpoint.name=projects/*/locations/*/indexEndpoints/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
indexEndpoint.name

string

Output only. Resource name of the IndexEndpoint. Format: projects/{project}/locations/{location}/indexEndpoints/{indexEndpointId}

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. Field mask is used to specify the fields to be overwritten in the IndexEndpoint resource by the update. The fields specified in the updateMask are relative to the resource, not the full request. A field of the resource will be overwritten if it is in the mask. Empty field mask is not allowed. If the mask is "*", then this is a full replacement of the resource.

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

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:

  • visionai.indexEndpoints.update

For more information, see the IAM documentation.