REST Resource: locations.operations

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 result can be only one of the following:
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // End of list of possible types for union field result.
}
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

object

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 "@type" contém um URI que identifica o tipo. Exemplo: { "id": 1234, "@type": "types.example.com/standard/id" }.
done

boolean

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, exatamente um de error ou response está definido. result só pode ser uma das seguintes opções:
error

object (Status)

O resultado do erro da operação em caso de falha ou cancelamento.

response

object

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.

Um objeto que contém campos de um tipo arbitrário. Um campo adicional "@type" contém um URI que identifica o tipo. Exemplo: { "id": 1234, "@type": "types.example.com/standard/id" }.

Métodos

get

 Obtém o estado mais recente de uma operação de execução longa.