Package google.longrunning

Índice

Operações

Gerir operações de longa duração com um serviço de API.

Quando um método da API demora normalmente muito tempo a ser concluído, pode ser concebido para devolver Operation ao cliente. O cliente pode usar esta interface para receber a resposta real de forma assíncrona através da sondagem do recurso de operação ou passar o recurso de operação para outra API (como a API Pub/Sub) para receber a resposta. Qualquer serviço de API que devolva operações de longa duração deve implementar a interface Operations para que os programadores possam ter uma experiência de cliente consistente.

CancelOperation

rpc CancelOperation(CancelOperationRequest) returns (Empty)

Inicia o cancelamento assíncrono numa operação de longa duração. O servidor faz o seu melhor para cancelar a operação, mas o sucesso não é garantido. Se o servidor não suportar este método, devolve google.rpc.Code.UNIMPLEMENTED. Os clientes podem usar Operations.GetOperation ou outros métodos para verificar se o cancelamento foi bem-sucedido ou se a operação foi concluída apesar do cancelamento. Em caso de cancelamento bem-sucedido, a operação não é eliminada. Em vez disso, torna-se uma operação com um valor Operation.error com um google.rpc.Status.code de 1, correspondente a Code.CANCELLED.

Â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.
GetOperation

rpc GetOperation(GetOperationRequest) returns (Operation)

Obtém o estado mais recente de uma operação de execução longa. Os clientes podem usar este método para sondar o resultado da operação em intervalos, conforme recomendado pelo serviço de API.

Â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.operations.get

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

rpc ListOperations(ListOperationsRequest) returns (ListOperationsResponse)

Apresenta as operações que correspondem ao filtro especificado no pedido. Se o servidor não suportar este método, devolve UNIMPLEMENTED.

Â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.operations.list

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

CancelOperationRequest

A mensagem de pedido para Operations.CancelOperation.

Campos
name

string

O nome do recurso da operação a cancelar.

GetOperationRequest

A mensagem de pedido para Operations.GetOperation.

Campos
name

string

O nome do recurso da operação.

ListOperationsRequest

A mensagem de pedido para Operations.ListOperations.

Campos
name

string

O nome do recurso principal da operação.
filter

string

O filtro de lista padrão.
page_size

int32

O tamanho da página da lista padrão.
page_token

string

O símbolo da página de lista padrão.
return_partial_success

bool

Quando definido como true, as operações acessíveis são devolvidas como normais e as inacessíveis são devolvidas no campo [ListOperationsResponse.unreachable].

Só pode ser true quando lê em várias coleções, por exemplo, quando parent está definido como "projects/example/locations/-".

Este campo não é suportado por predefinição e resulta num erro UNIMPLEMENTED se for definido, a menos que esteja explicitamente documentado de outra forma na documentação específica do serviço ou produto.

ListOperationsResponse

A mensagem de resposta para Operations.ListOperations.

Campos
operations[]

Operation

Uma lista de operações que corresponde ao filtro especificado no pedido.
next_page_token

string

O símbolo da página seguinte da lista padrão.
unreachable[]

string

Lista não ordenada. Recursos inacessíveis. Preenchido quando o pedido define ListOperationsRequest.return_partial_success e lê em todas as coleções, por exemplo, quando tenta listar todos os recursos em todas as localizações suportadas.

Operação

Este recurso representa uma operação de longa duração que é o resultado de uma chamada API de rede.

Campos
name

string

O nome atribuído pelo servidor, que é exclusivo apenas no mesmo serviço que o devolve originalmente. Se usar o mapeamento HTTP predefinido, o name deve ser um nome de recurso que termine com operations/{unique_id}.
metadata

Any

Metadados específicos do serviço associados à operação. Normalmente, contém informações de progresso e metadados comuns, como a hora de criação. Alguns serviços podem não fornecer esses metadados. Qualquer método que devolva uma operação de longa duração deve documentar o tipo de metadados, se existir.
done

bool

Se o valor for false, significa que a operação ainda está em curso. Se true, a operação é concluída e está disponível error ou response.
Campo de união result. O resultado da operação, que pode ser um error ou um response válido. Se done == false, nem error nem response estão definidos. Se done == true, pode definir exatamente um de error ou response. Alguns serviços podem não fornecer o resultado. result só pode ser uma das seguintes opções:
error

Status

O resultado do erro da operação em caso de falha ou cancelamento.
response

Any

A resposta normal e bem-sucedida da operação. Se o método original não devolver dados em caso de êxito, como Delete, a resposta é google.protobuf.Empty. Se o método original for o padrão Get/Create/Update, a resposta deve ser o recurso. Para outros métodos, a resposta deve ter o tipo XxxResponse, em que Xxx é o nome do método original. Por exemplo, se o nome do método original for TakeSnapshot(), o tipo de resposta inferido é TakeSnapshotResponse.