Se usó la API de Cloud Translation para traducir esta página.
Switch to English

google.longrunning paquete

Índice

operaciones

Maneja las operaciones de larga duración con un servicio API.

Cuando un método de API normalmente tarda mucho tiempo en completarse, puede ser diseñado para devolver Operation al cliente, y el cliente puede utilizar esta interfaz para recibir la respuesta verdadera forma asíncrona sondeando el recurso operación, o pasar el recurso operación a otra API ( tales como la nube de Google Pub / Sub API) para recibir la respuesta. Cualquier servicio API que los rendimientos de larga duración operaciones deberían aplicar el Operations de interfaz que los desarrolladores puedan tener una experiencia de cliente consistente.

CancelOperation

rpc CancelOperation( CancelOperationRequest ) returns ( Empty )

Inicia la cancelación asíncrona en una operación de larga duración. El servidor hace un mayor esfuerzo para cancelar la operación, pero el éxito no está garantizado. Si el servidor no soporta este método, devuelve google.rpc.Code.UNIMPLEMENTED . Los clientes pueden utilizar Operations.GetOperation u otros métodos para comprobar si la cancelación se realizó correctamente o si la operación se ha completado a pesar de cancelación. Sobre la cancelación exitosa, no se elimina la operación; en vez, se convierte en una operación con una Operation.error valor con un google.rpc.Status.code de 1, correspondiente a Code.CANCELLED .

autorización Scopes

Requiere uno de los siguientes ámbitos de OAuth:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulte la Introducción a la autenticación .

DeleteOperation

rpc DeleteOperation( DeleteOperationRequest ) returns ( Empty )

Elimina una operación de larga duración. Este método indica que el cliente ya no está interesado en el resultado de la operación. No cancela la operación. Si el servidor no soporta este método, devuelve google.rpc.Code.UNIMPLEMENTED .

autorización Scopes

Requiere uno de los siguientes ámbitos de OAuth:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulte la Introducción a la autenticación .

GetOperation

rpc GetOperation( GetOperationRequest ) returns ( Operation )

Obtiene el último estado de una operación de larga duración. Los clientes pueden utilizar este método para sondear el resultado de la operación a intervalos a lo recomendado por el servicio API.

autorización Scopes

Requiere uno de los siguientes ámbitos de OAuth:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulte la Introducción a la autenticación .

ListOperations

rpc ListOperations( ListOperationsRequest ) returns ( ListOperationsResponse )

enumera las operaciones que coinciden con el filtro especificado en la solicitud. Si el servidor no soporta este método, devuelve UNIMPLEMENTED .

NOTA: el name la unión permite que los servicios de la API para anular la unión de utilizar diferentes formatos de nombre de recurso, como users/*/operations . Para anular la unión, servicios API puede agregar una unión tal como "/v1/{name=users/*}/operations" a su configuración del servicio. Para compatibilidad con versiones anteriores, el nombre por defecto incluye el ID de colección operaciones, sin embargo los usuarios principal debe asegurar el nombre del enlace es el recurso de los padres, sin el ID de colección operaciones.

autorización Scopes

Requiere uno de los siguientes ámbitos de OAuth:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulte la Introducción a la autenticación .

WaitOperation

rpc WaitOperation( WaitOperationRequest ) returns ( Operation )

Espera a que la operación de larga duración especificada hasta que se hace o se alcanza como máximo un tiempo de espera especificado, devolviendo el último estado. Si la operación ya está hecho, el último estado se devuelve inmediatamente. Si el tiempo de espera especificado es mayor que el tiempo de espera predeterminado HTTP / RPC, se utiliza el tiempo de espera de HTTP / RPC. Si el servidor no soporta este método, devuelve google.rpc.Code.UNIMPLEMENTED . Observe que este método es sobre una base de mejor esfuerzo. Se puede devolver el último estado antes de que el tiempo de espera especificado (incluso en forma inmediata), es decir, incluso una respuesta inmediata hay garantía de que la operación se realiza.

autorización Scopes

Requiere uno de los siguientes ámbitos de OAuth:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulte la Introducción a la autenticación .

CancelOperationRequest

El mensaje de solicitud de Operations.CancelOperation .

Campos
name

string

El nombre del recurso de operación que se cancela.

DeleteOperationRequest

El mensaje de solicitud de Operations.DeleteOperation .

Campos
name

string

El nombre del recurso de la operación que desea eliminar.

GetOperationRequest

El mensaje de solicitud de Operations.GetOperation .

Campos
name

string

El nombre del recurso operación.

ListOperationsRequest

El mensaje de solicitud de Operations.ListOperations .

Campos
name

string

El nombre de recursos para padres de la operación.

filter

string

El filtro de lista estándar.

page_size

int32

El tamaño de página de lista estándar.

page_token

string

La página de lista estándar de fichas.

ListOperationsResponse

El mensaje de respuesta para Operations.ListOperations .

Campos
operations[]

Operation

Una lista de operaciones que coincide con el filtro especificado en la solicitud.

next_page_token

string

La lista estándar de página siguiente token.

Operación

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

Campos
name

string

El nombre asignada por el servidor, que sólo es único dentro del mismo servicio que devuelve originalmente. Si utiliza el valor por defecto de HTTP mapeo, el name debe ser un nombre de recurso que termina con operations/{unique_id} .

metadata

Any

metadatos de servicio específica asociada con la operación. Normalmente contiene información de progreso y metadatos comunes tales como crear tiempo. Algunos servicios podrían no proporcionar tales metadatos. Cualquier método que devuelve una operación de larga duración debe documentar el tipo de metadatos, en su caso.

done

bool

Si el valor es false , significa que la operación está aún en curso. Si true , la operación se ha completado, y, o bien error o response está disponible.

Unión campo de result . El resultado de la operación, que puede ser o bien un error o una válida response . Si done == false , ni error ni response se encuentra. Si done == true , exactamente uno de error o de response se establece. result sólo puede ser uno de los siguientes:
error

Status

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

response

Any

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

WaitOperationRequest

El mensaje de solicitud de Operations.WaitOperation .

Campos
name

string

El nombre del recurso operación para esperar en.

timeout

Duration

La duración máxima de espera antes de tiempo de espera. Si se deja en blanco, la espera será, como máximo, el tiempo permitido por el protocolo HTTP / RPC subyacente. Si también se especifica fecha límite contexto RPC, se utilizará la más corta.