Package google.longrunning

Importante: para aceder ao URL indicado entre parênteses, tem de ter ligação à Internet. O URL é fornecido para acesso fora do seu ambiente isolado.

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.

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. NOTA: a associação name permite que os serviços API substituam a associação para usar esquemas de nomes de recursos diferentes, como users/*/operations. Para substituir a associação, os serviços de API podem adicionar uma associação, como "/v1/{name=users/*}/operations", à respetiva configuração de serviço. Para compatibilidade retroativa, o nome predefinido inclui o ID da coleção de operações. No entanto, os utilizadores que substituem o nome predefinido têm de garantir que a associação de nomes é o recurso principal, sem o ID da coleção de operações.

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 da lista padrão.

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 de página seguinte da lista padrã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 (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.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 (/distributed-cloud/hosted/docs/latest/gdch/apis/vertex-ai/translation/rpc/google.rpc#google.rpc.Status) O resultado do erro da operação em caso de falha ou cancelamento.
response	Any (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.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.