Recurso: Operação
Este recurso representa uma operação de longa duração que é o resultado de uma chamada de API de rede.
O campo response
da operação será UploadReleaseResponse .
Representação JSON |
---|
{ "name": string, "metadata": { "@type": string, field1: ..., ... }, "done": boolean, // Union field |
Campos | |
---|---|
name | O nome atribuído pelo servidor, que é exclusivo apenas no mesmo serviço que o retorna originalmente. Se você usar o mapeamento HTTP padrão, o |
metadata | Metadados específicos do serviço associados à operação. Normalmente contém informações de progresso e metadados comuns, como tempo de criação. Alguns serviços podem não fornecer esses metadados. Qualquer método que retorne uma operação de longa duração deve documentar o tipo de metadados, se houver. Um objeto que contém campos de tipo arbitrário. Um campo adicional |
done | Se o valor for |
result do campo de união. O resultado da operação, que pode ser um error ou uma response válida. Se done == false , nem error nem response serão definidos. Se done == true , exatamente um error ou response pode ser definido. Alguns serviços podem não fornecer o resultado. result pode ser apenas um dos seguintes: | |
error | O resultado do erro da operação em caso de falha ou cancelamento. |
response | A resposta normal da operação em caso de sucesso. Neste caso será um UploadReleaseResponse . |
Status
O tipo Status
define um modelo de erro lógico adequado para diferentes ambientes de programação, incluindo APIs REST e APIs RPC. É usado pelo gRPC . Cada mensagem Status
contém três dados: código de erro, mensagem de erro e detalhes do erro.
Você pode descobrir mais sobre esse modelo de erro e como trabalhar com ele no API Design Guide .
Representação JSON |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
Campos | |
---|---|
code | O código de status, que deve ser um valor enum de |
message | Uma mensagem de erro voltada ao desenvolvedor, que deve estar em inglês. Qualquer mensagem de erro voltada ao usuário deve ser localizada e enviada no campo |
details[] | Uma lista de mensagens que contêm os detalhes do erro. Há um conjunto comum de tipos de mensagens para uso pelas APIs. Um objeto que contém campos de tipo arbitrário. Um campo adicional |
Métodos | |
---|---|
| Obtém o estado mais recente de uma operação de longa duração. |