REST Resource: projects.locations.operations

Recurso: Operation

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

Representación JSON
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // End of mutually exclusive fields.
}
Campos
name

string

El nombre asignado por el servidor, que solo es único dentro del mismo servicio que lo muestra en un principio. Si usas la asignación HTTP predeterminada, el name debe ser un nombre de recurso que termine con operations/{uniqueId}.

metadata

object

{

createTime: Es la fecha y hora en que se creó la operación.

endTime: Es la hora en la que finalizó la operación.

target: Es la ruta de acceso al recurso definida por el servidor para el destino de la operación.

verb: Nombre del verbo que ejecuta la operación.

statusDetail: Es el estado legible de la operación, si lo hay.

cancelRequested: Identifica si el usuario solicitó la cancelación de la operación. Las operaciones que se cancelaron de forma correcta tienen el valor Operation.error con un google.rpc.Status.code de 1, que corresponde a Code.CANCELLED.

apiVersion: Es la versión de la API que se usó para iniciar la operación.

}

done

boolean

Si el valor es false, significa que la operación aún está en progreso. Si es true, la operación está completa, y error o response están disponibles.

El resultado de la operación, que puede ser un error o una response válida. Si done == false, no se establecen error ni response. Si done == true, se puede establecer error o response. Es posible que algunos servicios no proporcionen el resultado. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
error

object (Status)

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

response

object

Es la respuesta normal y correcta de la operación. Si el método original no devuelve datos en caso de éxito, como Delete, la respuesta es google.protobuf.Empty. Si el método original es Get, Create o Update estándar, la respuesta debe ser el recurso. Para otros métodos, la respuesta debe tener el tipo XxxResponse, en la que 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.

Fin de los campos mutuamente excluyentes.

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