Method: projects.locations.collections.indexes.patch

Actualiza los parámetros de un solo índice.

Solicitud HTTP

PATCH https://vectorsearch.googleapis.com/v1beta/{index.name}

Parámetros de ruta

Parámetros
index.name

string

Identificador. Nombre del recurso

Parámetros de consulta

Parámetros
updateMask

string (FieldMask format)

Es opcional. Especifica los campos que la actualización reemplazará en el recurso Index. Los campos especificados en updateMask se relacionan con el recurso, no con la solicitud completa. Un campo se reemplazará si está en la máscara. Si el usuario no proporciona una máscara, se reemplazarán todos los campos presentes en la solicitud con valores no vacíos.

Se pueden actualizar los siguientes campos: * displayName * description * labels * dedicatedInfrastructure.autoscaling_spec.min_replica_count * dedicatedInfrastructure.autoscaling_spec.max_replica_count

Si se proporciona * en updateMask, se realizará el reemplazo completo de los campos mutables.

Esta es una lista separada por comas de los nombres de campos completamente calificados. Ejemplo: "user.displayName,photo".

requestId

string

Opcional. Un ID de solicitud opcional para identificar solicitudes. Especifica un ID de solicitud único para que, si debes reintentar la solicitud, el servidor sepa que debe ignorarla si ya se completó. El servidor lo garantizará durante, al menos, 60 minutos después de la primera solicitud.

Por ejemplo, imagina una situación en la que haces una solicitud inicial y se agota el tiempo de espera. Si vuelves a hacer la solicitud con el mismo ID, el servidor puede verificar si se recibió la operación original con el mismo ID y, de ser así, ignorar la segunda solicitud. Esto evita que los clientes creen compromisos duplicados por accidente.

El ID de solicitud debe ser un UUID válido, con la excepción de que no se admite ningún UUID cero (00000000-0000-0000-0000-000000000000).

Cuerpo de la solicitud

El cuerpo de la solicitud contiene una instancia de Index.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Operation.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • vectorsearch.indexes.update

Para obtener más información, consulta la documentación de IAM.