Recurso: Operation
Este recurso representa uma operação de longa duração que é o resultado de uma chamada API de rede.
Representação JSON |
---|
{ "name": string, "metadata": { "@type": string, field1: ..., ... }, "done": boolean, // Union field |
Campos | |
---|---|
name |
O nome atribuído pelo servidor, que só é exclusivo no mesmo serviço que o devolve originalmente. Se usar o mapeamento HTTP predefinido, o |
metadata |
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. Um objeto que contém campos de um tipo arbitrário. Um campo adicional |
done |
Se o valor for |
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 |
O resultado do erro da operação em caso de falha ou cancelamento. |
response |
A resposta normal e bem-sucedida da operação. Se o método original não devolver dados em caso de êxito, como Um objeto que contém campos de um tipo arbitrário. Um campo adicional |
Métodos |
|
---|---|
|
Inicia o cancelamento assíncrono numa operação de longa duração. |
|
Elimina uma operação de longa duração. |
|
Obtém o estado mais recente de uma operação de execução longa. |
|
Apresenta as operações que correspondem ao filtro especificado no pedido. |