Índice
Operations
(interface)CancelOperationRequest
(mensagem)DeleteOperationRequest
(mensagem)GetOperationRequest
(mensagem)ListOperationsRequest
(mensagem)ListOperationsResponse
(mensagem)Operation
(mensagem)
Operações
Operações de longa duração são gerenciadas com um serviço de API.
Quando um método da API leva muito tempo para ser concluído, ele pode ser configurado para retornar a Operation
ao cliente, que poderá usar essa interface para receber a resposta real de maneira assíncrona. Para isso, o cliente poderá pesquisar o recurso de operação ou transmiti-lo para outra API, por exemplo, a API Google Cloud Pub/Sub. Qualquer serviço de API que retorna operações de longa duração precisa implementar a interface de Operations
para que os desenvolvedores possam ter uma experiência de cliente consistente.
CancelOperation | |
---|---|
Inicia o cancelamento assíncrono de uma operação de longa duração. São feitas várias tentativas para cancelar a operação no servidor, mas o sucesso não é garantido. Se esse método não for compatível com o servidor, ele retornará
|
DeleteOperation | |
---|---|
Exclui uma operação de longa duração. Este método indica que o cliente não está mais interessado no resultado da operação. Ele não cancela a operação. Se esse método não for compatível com o servidor, ele retornará
|
GetOperation | |
---|---|
Recebe o estado mais recente de uma operação de longa duração. Os clientes usam este método para pesquisar o resultado da operação em intervalos, conforme recomendado pelo serviço da API.
|
ListOperations | |
---|---|
Lista as operações que correspondem ao filtro especificado na solicitação. Se o servidor não permitir este método, ele retornará Observação: a vinculação
|
CancelOperationRequest
A mensagem de solicitação para Operations.CancelOperation
.
Campos | |
---|---|
name |
O nome do recurso de operação a ser cancelado. |
DeleteOperationRequest
A mensagem de solicitação para Operations.DeleteOperation
.
Campos | |
---|---|
name |
O nome do recurso de operação que será excluído. |
GetOperationRequest
A mensagem de solicitação para Operations.GetOperation
.
Campos | |
---|---|
name |
O nome do recurso de operação. |
ListOperationsRequest
A mensagem de solicitação para Operations.ListOperations
.
Campos | |
---|---|
name |
Nome do recurso pai da operação. |
filter |
Uma expressão para filtrar os resultados da solicitação.
Veja alguns exemplos de uso do filtro:
|
page_size |
O tamanho de página de lista padrão. |
page_token |
O token de página de lista padrão. |
ListOperationsResponse
A mensagem de resposta para Operations.ListOperations
.
Campos | |
---|---|
operations[] |
Uma lista de operações correspondente ao filtro especificado na solicitação. |
next_page_token |
O token de próxima página da lista padrão. |
Operação
Este recurso representa uma operação de longa duração resultante de uma chamada à API de rede.
Campos | ||
---|---|---|
name |
O nome atribuído pelo servidor, que é exclusivo somente no mesmo serviço que o retorna originalmente. Quando você usa o mapeamento HTTP padrão, o |
|
metadata |
Metadados específicos do serviço associados à operação. Eles geralmente contêm informações sobre o progresso e metadados comuns como a hora da criação. Em alguns serviços, esses metadados talvez não sejam fornecidos. Em qualquer método que retorne uma operação de longa duração, o tipo de metadados será documentado, se houver. |
|
done |
Se o valor é |
|
Campo de união result . O resultado da operação, que pode ser um error ou uma response válida. Se done == false , nem error nem response é definido. Se done == true , exatamente um error ou response é definido. O result será somente um destes: |
||
error |
Resultado do erro da operação em caso de falha ou cancelamento. |
|
response |
A resposta normal da operação, em caso de êxito. Se o método original não retornar dados em caso de sucesso, como |