REST Resource: locations.operations

Recurso: Operación

Este recurso representa una operación de larga duración que es el resultado de una llamada a la API de red.

Representación 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

El nombre asignado por el servidor, que solo es exclusivo dentro del mismo servicio que lo devuelve originalmente. Si usas la asignación HTTP predeterminada, name debe ser un nombre de recurso que termine en operations/{unique_id}.

metadata

object

Metadatos específicos del servicio asociados con la operación. Por lo general, contienen información de progreso y metadatos comunes, como la hora de creación. Es posible que algunos servicios no proporcionen dichos metadatos. Cualquier método que devuelva una operación de larga duración debe documentar el tipo de metadatos, si corresponde.

Un objeto que contiene campos de un tipo arbitrario. Un campo adicional "@type" contiene un URI que identifica el tipo. Ejemplo: { "id": 1234, "@type": "types.example.com/standard/id" }
done

boolean

Si el valor es false, significa que la operación sigue en curso. Si true, la operación se completa y se puede usar error o response.

Campo de unión result. El resultado de la operación, que puede ser un error o un response válido. Si done == false, no se define ni error ni response. Si done == true, se define exactamente uno de los valores error o response. result solo puede ser una de las siguientes cosas:
error

object (Status)

El resultado del error de la operación en caso de fallo o cancelación.

response

object

La respuesta normal de la operación en caso de éxito. Si el método original no devuelve datos cuando se completa correctamente (por ejemplo, Delete), la respuesta es google.protobuf.Empty. Si el método original es estándar Get/Create/Update, la respuesta debe ser el recurso. En el caso de otros métodos, la respuesta debe tener el tipo XxxResponse, donde Xxx es el nombre del método original. Por ejemplo, si el nombre del método original es TakeSnapshot(), el tipo de respuesta inferido es TakeSnapshotResponse.

Un objeto que contiene campos de un tipo arbitrario. Un campo adicional "@type" contiene un URI que identifica el tipo. Ejemplo: { "id": 1234, "@type": "types.example.com/standard/id" }

Métodos

get

 Obtiene el estado más reciente de una operación de larga duración.