Method: projects.locations.collections.engines.patch

Met à jour un Engine

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
engine.name

string

Immuable. Identifiant. Nom complet de la ressource du moteur.

Ce champ doit être une chaîne encodée au format UTF-8 d'une longueur maximale de 1 024 caractères.

Format : projects/{project}/locations/{location}/collections/{collection}/engines/{engine}. Le moteur doit comporter entre 1 et 63 caractères valides : /[a-z0-9][a-z0-9-_]*/. Dans le cas contraire, une erreur INVALID_ARGUMENT est renvoyée.

Paramètres de requête

Paramètres
updateMask

string (FieldMask format)

Indique les champs du Engine fourni à mettre à jour.

Si un champ non accepté ou inconnu est fourni, une erreur INVALID_ARGUMENT est renvoyée.

Il s'agit d'une liste de noms de champs complets séparés par une virgule. Exemple : "user.displayName,photo"

Corps de la requête

Le corps de la requête contient une instance de Engine.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de Engine.

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

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

Pour plus d'informations, consultez la page Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource name :

  • discoveryengine.engines.update

Pour en savoir plus, consultez la documentation IAM.