ListOperationsResponse

A mensagem de resposta para Operations.ListOperations.

Representação JSON 
{
  "operations": [
    {
      object (Operation)
    }
  ],
  "nextPageToken": string
}
Campos
operations[]

object (Operation)

Uma lista de operações que corresponde ao filtro especificado no pedido.
nextPageToken

string

O símbolo de página seguinte da lista padrão.

Operação

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 é exclusivo apenas 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/{uniqueId}.
metadata

object

{

createTime: a hora em que a operação foi criada.

endTime: a hora em que a operação terminou.

target: caminho do recurso definido pelo servidor para o destino da operação.

verb: nome do verbo executado pela operação.

statusDetail: estado legível por humanos da operação, se existir.

cancelRequested: identifica se o utilizador pediu o cancelamento da operação. As operações que foram canceladas com êxito têm um valor de Operation.error com um google.rpc.Status.code de 1, o que corresponde a Code.CANCELLED.

apiVersion: versão da API usada para iniciar a operação.

}
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, 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

object (Status)

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

object

A resposta normal e bem-sucedida da operação. 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.

Estado

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 elementos de dados: código de erro, mensagem de erro e detalhes do erro.

Pode saber mais acerca deste modelo de erro e como trabalhar com ele no guia de design de APIs.

Representação JSON 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Campos
code

integer

O código de estado, que deve ser um valor enum de google.rpc.Code.
message

string

Uma mensagem de erro destinada a programadores, que deve estar em inglês. Todas as mensagens de erro apresentadas ao utilizador devem ser localizadas e enviadas no campo google.rpc.Status.details ou localizadas pelo cliente.
details[]

object

Uma lista de mensagens que contêm os detalhes do erro. Existe um conjunto comum de tipos de mensagens para as APIs usarem.