Method: projects.locations.collections.engines.patch

Atualiza um Engine.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
engine.name

string

Imutável. Identificador. O nome totalmente qualificado do recurso do mecanismo.

Este campo precisa ser uma string codificada em UTF-8 com um limite de 1.024 caracteres.

Formato: o mecanismo projects/{project}/locations/{location}/collections/{collection}/engines/{engine} precisa ter de 1 a 63 caracteres, e os caracteres válidos são /[a-z0-9][a-z0-9-_]*/. Caso contrário, um erro INVALID_ARGUMENT será retornado.

Parâmetros de consulta

Parâmetros
updateMask

string (FieldMask format)

Indica quais campos no Engine fornecido serão atualizados.

Caso seja fornecido um campo sem suporte ou desconhecido, será retornado um erro INVALID_ARGUMENT.

Uma lista separada por vírgulas de nomes de campos totalmente qualificados. Exemplo: "user.displayName,photo".

Corpo da solicitação

O corpo da solicitação contém uma instância de Engine.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Engine.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • discoveryengine.engines.update

Para mais informações, consulte a documentação do IAM.