Package google.longrunning

Importante: Para acceder a la URL que aparece entre paréntesis, debes conectarte a Internet. La URL se proporciona para acceder fuera de tu entorno aislado.

Operaciones

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

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

GetOperation
rpc GetOperation(GetOperationRequest) returns (Operation) Obtiene el estado más reciente de una operación de larga duración. Los clientes pueden usar este método para sondear el resultado de la operación a intervalos recomendados por el servicio de API.

ListOperations

rpc ListOperations(ListOperationsRequest) returns (ListOperationsResponse) Enumera las operaciones que coinciden con el filtro especificado en la petición. Si el servidor no admite este método, devuelve UNIMPLEMENTED. NOTA: El enlace name permite que los servicios de la API anulen el enlace para usar otros esquemas de nombres de recursos, como users/*/operations. Para anular el enlace, los servicios de API pueden añadir un enlace como "/v1/{name=users/*}/operations" a su configuración de servicio. En el caso de la compatibilidad con versiones anteriores, el nombre predeterminado incluye el ID de recopilación de operaciones. Sin embargo, los usuarios principales deben asegurarse de que el enlace de nombre sea el recurso principal, sin el ID de recopilación de operaciones.

GetOperationRequest

El mensaje de solicitud de Operations.GetOperation.

Campos
name	string El nombre del recurso de operación.

ListOperationsRequest

El mensaje de solicitud de 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 la lista estándar.
page_token	string El token de la página de lista estándar.

ListOperationsResponse

Mensaje de respuesta de Operations.ListOperations.

Campos
operations[]	Operation Una lista de operaciones que coincide con el filtro especificado en la petición.
next_page_token	string El token de la lista siguiente de la lista.

Operation

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 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	Any (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Any) 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.
done	bool 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	Status (/distributed-cloud/hosted/docs/latest/gdch/apis/vertex-ai/translation/rpc/google.rpc#google.rpc.Status) El resultado del error de la operación en caso de fallo o cancelación.
response	Any (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Any) La respuesta normal de la operación en caso de éxito. Si el método original no devuelve datos cuando se completa correctamente (por ejemplo, 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.