Package google.longrunning

Índice

Operaciones

Gestiona operaciones de larga duración con un servicio API.

Cuando un método API normalmente tarda mucho en completarse, se puede diseñar para devolver Operation al cliente, y el cliente puede usar esta interfaz para recibir la respuesta real de forma asíncrona sondeando el recurso de operación o pasando el recurso de operación a otra API ( como Pub/Sub API) para recibir la respuesta. Cualquier servicio API que devuelva operaciones de larga duración debe implementar la interfaz Operations para que los desarrolladores puedan tener una experiencia de cliente consistente.

Cancelar operación

rpc CancelOperation( CancelOperationRequest ) returns ( Empty )

Inicia la cancelación asincrónica en una operación de larga duración. El servidor hace todo lo posible para cancelar la operación, pero no se garantiza el éxito. Si el servidor no admite este método, devuelve google.rpc.Code.UNIMPLEMENTED . Los clientes pueden usar Operations.GetOperation u otros métodos para verificar si la cancelación se realizó correctamente o si la operación se completó a pesar de la cancelación. Si la cancelación es exitosa, la operación no se elimina; en cambio, se convierte en una operación con un valor Operation.error con un google.rpc.Status.code de 1, correspondiente a Code.CANCELLED .

Ámbitos de autorización

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 Descripción general de la autenticación .

EliminarOperación

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 admite este método, devuelve google.rpc.Code.UNIMPLEMENTED .

Ámbitos de autorización

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 Descripción general de la autenticación .

Obtener operación

rpc GetOperation( GetOperationRequest ) returns ( Operation )

Obtiene el estado más reciente 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 recomendados por el servicio API.

Ámbitos de autorización

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 Descripción general de la autenticación .

Lista de operaciones

rpc ListOperations( ListOperationsRequest ) returns ( ListOperationsResponse )

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

Ámbitos de autorización

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 Descripción general de la autenticación .

EsperarOperación

rpc WaitOperation( WaitOperationRequest ) returns ( Operation )

Espera hasta que finalice la operación de larga duración especificada o alcance como máximo un tiempo de espera especificado, devolviendo el último estado. Si la operación ya se realizó, se devuelve inmediatamente el último estado. Si el tiempo de espera especificado es mayor que el tiempo de espera predeterminado de HTTP/RPC, se utiliza el tiempo de espera de HTTP/RPC. Si el servidor no admite este método, devuelve google.rpc.Code.UNIMPLEMENTED . Tenga en cuenta que este método se basa en el mejor esfuerzo. Puede devolver el último estado antes del tiempo de espera especificado (incluso inmediatamente), lo que significa que incluso una respuesta inmediata no es garantía de que la operación se haya realizado.

Ámbitos de autorización

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 Descripción general de la autenticación .

Cancelar solicitud de operación

El mensaje de solicitud para Operations.CancelOperation .

Campos
name

string

El nombre del recurso de operación que se cancelará.

Eliminar solicitud de operación

El mensaje de solicitud para Operations.DeleteOperation .

Campos
name

string

El nombre del recurso de operación que se eliminará.

Obtener solicitud de operación

El mensaje de solicitud para Operations.GetOperation .

Campos
name

string

El nombre del recurso de operación.

ListaOperacionesSolicitud

El mensaje de solicitud para Operations.ListOperations .

Campos
name

string

El nombre del recurso principal 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

El token de página de lista estándar.

ListaOperacionesRespuesta

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

El token estándar de la página siguiente de la lista.

Operación

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

Campos
name

string

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

metadata

Any

Metadatos específicos del servicio asociados con la operación. Por lo general, contiene 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.

done

bool

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

result de campo de la 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 exactamente uno de error o response . Es posible que algunos servicios no proporcionen el resultado. result puede ser sólo uno de los siguientes:
error

Status

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

response

Any

La respuesta normal y exitosa de la operación. Si el método original no devuelve datos sobre el éxito, como Delete , la respuesta es google.protobuf.Empty . Si el método original es Get / Create / Update estándar, la respuesta debe ser el recurso. Para 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 .

Esperar solicitud de operación

El mensaje de solicitud para Operations.WaitOperation .

Campos
name

string

El nombre del recurso de operación a esperar.

timeout

Duration

La duración máxima que se debe esperar antes de que se agote el tiempo. 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 la fecha límite del contexto RPC, se utilizará la más corta.