Method: projects.locations.collections.engines.patch

Atualiza um Engine

Pedido HTTP

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

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

Parâmetros de caminho

Parâmetros
engine.name

string

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

Este campo tem de ser uma string codificada em UTF-8 com um limite de comprimento de 1024 carateres.

Formato: o projects/{project}/locations/{location}/collections/{collection}/engines/{engine} do motor deve ter entre 1 e 63 carateres, e os carateres válidos são /[a-z0-9][a-z0-9-_]*/. Caso contrário, é devolvido um erro INVALID_ARGUMENT.

Parâmetros de consulta

Parâmetros
updateMask

string (FieldMask format)

Indica os campos no Engine fornecido a atualizar.

Se for fornecido um campo não suportado ou desconhecido, é devolvido um erro INVALID_ARGUMENT.

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

Corpo do pedido

O corpo do pedido contém uma instância de Engine.

Corpo da resposta

Se for bem-sucedido, o corpo da resposta contém uma instância de Engine.

Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

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

Para mais informações, consulte o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de IAM no recurso name:

  • discoveryengine.engines.update

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