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 único dentro del mismo servicio que lo devolvió originalmente. Si utiliza la asignación HTTP predeterminada, el name debe ser un nombre de recurso que termine en operations/{unique_id} .

metadata

object

Metadatos específicos del servicio asociados a la operación. Suelen contener información de progreso y metadatos comunes, como la hora de creación. Es posible que algunos servicios no proporcionen estos metadatos. Cualquier método que devuelva una operación de larga duración debe documentar el tipo de metadatos, si los hay.

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 es true , la operación se ha completado y se dispone de un error o response .

result del campo de unión. El resultado de la operación, que puede ser un error o una response válida. Si done = false , no se establece ni error ni response . Si done = ` true , se puede establecer solo uno de los dos: error o response . Algunos servicios podrían no proporcionar el resultado. result solo puede ser uno de los siguientes:
error

object ( Status )

El resultado erróneo 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 de éxito, 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. Para otros métodos, la respuesta debe ser del 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 API REST y RPC. Lo utiliza gRPC . Cada mensaje Status contiene tres datos: código de error, mensaje de error y detalles del error.

Puede obtener más información sobre este modelo de error y cómo trabajar con él en la Guía de diseño de API .

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

integer

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

message

string

Un mensaje de error para desarrolladores, que debe estar en inglés. Cualquier mensaje de error para usuarios debe estar localizado y enviado en el campo google.rpc.Status.details , o ser localizado por el cliente.

details[]

object

Una lista de mensajes que contienen los detalles del error. Existe un conjunto común de tipos de mensajes que las API pueden usar.

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 ejecución larga.

delete

 Elimina una operación de larga duración.

get

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

list

 Enumera las operaciones que coinciden con el filtro especificado en la solicitud.