REST Resource: projects.operations

Importante: para aceder ao URL indicado entre parênteses, tem de ter ligação à Internet. O URL é fornecido para acesso fora do seu ambiente isolado.

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

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" }.

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 por gRPC (https://github.com/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 sobre este modelo de erro e como trabalhar com ele no guia de design de APIs (https://cloud.google.com/apis/design/errors).

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.

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

cancel

 Inicia o cancelamento assíncrono numa operação de longa duração.

delete

 Elimina uma operação de longa duração.

get

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

list

 Apresenta as operações que correspondem ao filtro especificado no pedido.

wait

 Aguarda até que a operação de longa duração especificada seja concluída ou atinja, no máximo, um tempo limite especificado, devolvendo o estado mais recente.