Method: projects.locations.collections.engines.controls.patch

Actualiza un control.

No se puede cambiar el tipo de acción Control. Si el Control que se actualizará no existe, se mostrará un error NOT_FOUND.

Solicitud HTTP

PATCH https://discoveryengine.googleapis.com/v1alpha/{control.name=projects/*/locations/*/collections/*/engines/*/controls/*}

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
control.name

string

Inmutable. Nombre completamente calificado projects/*/locations/global/dataStore/*/controls/*

Parámetros de consulta

Parámetros
updateMask

string (FieldMask format)

Opcional. Indica qué campos del Control proporcionado se deben actualizar. NO se admiten los siguientes elementos:

Si no se configura o está vacío, se actualizan todos los campos compatibles.

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

Cuerpo de la solicitud

El cuerpo de la solicitud contiene una instancia de Control.

Cuerpo de la respuesta

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

Alcances de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

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

Permisos de IAM

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

  • discoveryengine.controls.update

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