Package google.longrunning

Índice

Operações

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

Quando um método de API demora normalmente muito tempo a ser concluído, pode ser concebido para devolver Operation ao cliente, e 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 Google Cloud 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.

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/cloud-vision

Para mais informações, consulte a Vista geral da autenticação.

GetOperationRequest

A mensagem de pedido para Operations.GetOperation.

Campos
name

string

O nome do recurso da operação.

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 só é exclusivo 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, exatamente um de error ou response está definido. 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 da operação em caso de êxito. 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.