Package google.longrunning
Operação
Este recurso representa uma operação de longa duração resultante de uma chamada à API de rede.
Campos |
name |
string
O nome atribuído pelo servidor, que é exclusivo somente no mesmo serviço que o retorna originalmente. Se você usar o mapeamento padrão de HTTP, name precisa ser um nome de recurso que termine com operations/{unique_id} .
|
metadata |
Any
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 |
bool
Se o valor for false , significa que a operação ainda está em andamento. Se for true , a operação será concluída e error ou response estarão disponíveis.
|
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 ou response estão definidos. Se done == true , exatamente um de error ou response pode ser definido. Alguns serviços podem não fornecer o resultado. result pode ser apenas de um dos tipos a seguir: |
error |
Status
Resultado do erro da operação em caso de falha ou cancelamento.
|
response |
Any
A resposta normal e bem-sucedida da operação. Se o método original não retornar dados em caso de êxito, como Delete , a resposta será google.protobuf.Empty . Se o método original for Get /Create /Update padrão, a resposta será o recurso. Para outros métodos, a resposta precisa ser do tipo XxxResponse , em que Xxx é o nome do método original. Por exemplo, se o nome do método original for TakeSnapshot() , o tipo inferido de resposta será TakeSnapshotResponse .
|
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2023-12-01 UTC.
[null,null,["Última atualização 2023-12-01 UTC."],[[["The `Operation` resource represents a long-running operation initiated by a network API call."],["Each operation has a unique name, metadata (often with progress information), and a status indicating if it's done."],["Upon completion (`done` is `true`), an operation provides either an `error` or a `response` indicating the outcome."],["The `response` field contains the operation's result, which varies depending on the original API method called."]]],["A long-running network API call is represented by an \"Operation\" resource. This resource includes a unique `name`, service-specific `metadata` about progress, and a `done` status flag. Upon completion (`done` is true), the `result` field will contain either an `error` status or a successful `response`. If the operation is in progress (`done` is false) `result` will not be set. The `response` contains data if it was a successful operation.\n"]]