[−][src]Struct gcp_client::google::longrunning::operations_client::OperationsClient
Manages long-running operations with an API service.
When an API method normally takes long time to complete, it can be designed
to return [Operation][google.longrunning.Operation] to the client, and the client can use this
interface to receive the real response asynchronously by polling the
operation resource, or pass the operation resource to another API (such as
Google Cloud Pub/Sub API) to receive the response. Any API service that
returns long-running operations should implement the Operations
interface
so developers can have a consistent client experience.
Implementations
impl<T> OperationsClient<T> where
T: GrpcService<BoxBody>,
T::ResponseBody: Body + HttpBody + Send + 'static,
T::Error: Into<StdError>,
<T::ResponseBody as HttpBody>::Error: Into<StdError> + Send,
[src]
T: GrpcService<BoxBody>,
T::ResponseBody: Body + HttpBody + Send + 'static,
T::Error: Into<StdError>,
<T::ResponseBody as HttpBody>::Error: Into<StdError> + Send,
pub fn new(inner: T) -> Self
[src]
pub fn with_interceptor(inner: T, interceptor: impl Into<Interceptor>) -> Self
[src]
pub async fn list_operations<'_>(
&'_ mut self,
request: impl IntoRequest<ListOperationsRequest>
) -> Result<Response<ListOperationsResponse>, Status>
[src]
&'_ mut self,
request: impl IntoRequest<ListOperationsRequest>
) -> Result<Response<ListOperationsResponse>, Status>
Lists operations that match the specified filter in the request. If the
server doesn't support this method, it returns UNIMPLEMENTED
.
NOTE: the name
binding allows API services to override the binding
to use different resource name schemes, such as users/*/operations
. To
override the binding, API services can add a binding such as
"/v1/{name=users/*}/operations"
to their service configuration.
For backwards compatibility, the default name includes the operations
collection id, however overriding users must ensure the name binding
is the parent resource, without the operations collection id.
pub async fn get_operation<'_>(
&'_ mut self,
request: impl IntoRequest<GetOperationRequest>
) -> Result<Response<Operation>, Status>
[src]
&'_ mut self,
request: impl IntoRequest<GetOperationRequest>
) -> Result<Response<Operation>, Status>
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,
request: impl IntoRequest<DeleteOperationRequest>
) -> Result<Response<()>, Status>
[src]
&'_ mut self,
request: impl IntoRequest<DeleteOperationRequest>
) -> Result<Response<()>, Status>
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,
request: impl IntoRequest<CancelOperationRequest>
) -> Result<Response<()>, Status>
[src]
&'_ mut self,
request: impl IntoRequest<CancelOperationRequest>
) -> Result<Response<()>, Status>
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][google.longrunning.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][google.longrunning.Operation.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
corresponding to Code.CANCELLED
.
pub async fn wait_operation<'_>(
&'_ mut self,
request: impl IntoRequest<WaitOperationRequest>
) -> Result<Response<Operation>, Status>
[src]
&'_ mut self,
request: impl IntoRequest<WaitOperationRequest>
) -> Result<Response<Operation>, Status>
Waits for the specified long-running operation until it 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<T: Clone> Clone for OperationsClient<T>
[src]
fn clone(&self) -> Self
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<T> Debug for OperationsClient<T>
[src]
Auto Trait Implementations
impl<T> !RefUnwindSafe for OperationsClient<T>
impl<T> Send for OperationsClient<T> where
T: Send,
T: Send,
impl<T> Sync for OperationsClient<T> where
T: Sync,
T: Sync,
impl<T> Unpin for OperationsClient<T> where
T: Unpin,
T: Unpin,
impl<T> !UnwindSafe for OperationsClient<T>
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
fn instrument(self, span: Span) -> Instrumented<Self>
[src]
fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> IntoRequest<T> for T
[src]
fn into_request(self) -> Request<T>
[src]
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,
fn vzip(self) -> V
impl<T> WithSubscriber for T
[src]
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
[src]
S: Into<Dispatch>,