Struct google_cloud_longrunning::autogen::operations_client::OperationsClient

pub struct OperationsClient { /* fields omitted */ }

Implementations

impl OperationsClient

pub async fn new(channel: Channel) -> Result<Self, Error>

pub async fn get_operation(
    &mut self,
    req: GetOperationRequest,
    opt: Option<BackoffRetrySettings>
) -> Result<Response<Operation>, Status>

GetOperation gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

pub async fn delete_operation(
    &mut self,
    req: DeleteOperationRequest,
    opt: Option<BackoffRetrySettings>
) -> Result<Response<()>, Status>

DeleteOperation deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED.

pub async fn cancel_operation(
    &mut self,
    req: CancelOperationRequest,
    opt: Option<BackoffRetrySettings>
) -> Result<Response<()>, Status>

CancelOperation starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

pub async fn wait_operation(
    &mut self,
    req: WaitOperationRequest,
    opt: Option<BackoffRetrySettings>
) -> Result<Response<Operation>, Status>

WaitOperation waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Trait Implementations

impl Clone for OperationsClient

fn clone(&self) -> OperationsClient

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.