REST Resource: projects.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 puede definir exactamente uno de los valores error o response. Es posible que algunos servicios no proporcionen el resultado. 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 y correcta de la operación. Si el método original no devuelve datos cuando se completa correctamente, como 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" }

Estado

El tipo Status define un modelo de error lógico adecuado para diferentes entornos de programación, incluidas las APIs REST y RPC. Lo usa gRPC. Cada mensaje Status contiene tres elementos de datos: código de error, mensaje de error y detalles del error.

Puedes consultar más información sobre este modelo de error y cómo trabajar con él en la guía de diseño de APIs.

Representación JSON 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Campos
code

integer

Código de estado, que debe ser un valor de enumeración de google.rpc.Code.
message

string

Un mensaje de error dirigido al desarrollador, que debe estar en inglés. Cualquier mensaje de error visible para el usuario debe localizarse y enviarse en el campo google.rpc.Status.details o localizarse por el cliente.
details[]

object

Una lista de mensajes que llevan los detalles del error. Hay un conjunto común de tipos de mensajes para que las API lo utilicen.

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

cancel

 Inicia la cancelación asincrónica en una operación de larga duración.

delete

 Elimina una operación de larga duración.

get

 Obtiene el último estado de una operación de larga duración.

list

 Enumera las operaciones que coinciden con el filtro especificado en la petición.