yandex-cloud 2025.4.14

Generated gRPC clients for the Yandex Cloud API
Documentation
/// An Operation resource. For more information, see \[Operation\](/docs/api-design-guide/concepts/operation).
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Operation {
    /// ID of the operation.
    #[prost(string, tag = "1")]
    pub id: ::prost::alloc::string::String,
    /// Description of the operation. 0-256 characters long.
    ///
    /// ex: Create VM, Stop VM, Delete Disk, Snapshot Disk, etc
    #[prost(string, tag = "2")]
    pub description: ::prost::alloc::string::String,
    /// Creation timestamp.
    #[prost(message, optional, tag = "3")]
    pub created_at: ::core::option::Option<::prost_types::Timestamp>,
    /// ID of the user or service account who initiated the operation.
    #[prost(string, tag = "4")]
    pub created_by: ::prost::alloc::string::String,
    /// The time when the Operation resource was last modified.
    #[prost(message, optional, tag = "5")]
    pub modified_at: ::core::option::Option<::prost_types::Timestamp>,
    /// If the value is `false`, it means the operation is still in progress.
    /// If `true`, the operation is completed, and either `error` or `response` is available.
    #[prost(bool, tag = "6")]
    pub done: bool,
    /// Service-specific metadata associated with the operation.
    /// It typically contains the ID of the target resource that the operation is performed on.
    /// Any method that returns a long-running operation should document the metadata type, if any.
    #[prost(message, optional, tag = "7")]
    pub metadata: ::core::option::Option<::prost_types::Any>,
    /// The operation result.
    /// If `done == false` and there was no failure detected, neither `error` nor `response` is set.
    /// If `done == false` and there was a failure detected, `error` is set.
    /// If `done == true`, exactly one of `error` or `response` is set.
    #[prost(oneof = "operation::Result", tags = "8, 9")]
    pub result: ::core::option::Option<operation::Result>,
}
/// Nested message and enum types in `Operation`.
pub mod operation {
    /// The operation result.
    /// If `done == false` and there was no failure detected, neither `error` nor `response` is set.
    /// If `done == false` and there was a failure detected, `error` is set.
    /// If `done == true`, exactly one of `error` or `response` is set.
    #[allow(clippy::derive_partial_eq_without_eq)]
    #[derive(Clone, PartialEq, ::prost::Oneof)]
    pub enum Result {
        /// The error result of the operation in case of failure or cancellation.
        #[prost(message, tag = "8")]
        Error(super::super::super::super::google::rpc::Status),
        /// The normal response of the operation in case of success.
        /// If the original method returns no data on success, such as Delete,
        /// the response is \[google.protobuf.Empty\].
        /// If the original method is the standard Create/Update,
        /// the response should be the target resource of the operation.
        /// Any method that returns a long-running operation should document the response type, if any.
        #[prost(message, tag = "9")]
        Response(::prost_types::Any),
    }
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetOperationRequest {
    /// ID of the Operation resource to return.
    #[prost(string, tag = "1")]
    pub operation_id: ::prost::alloc::string::String,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CancelOperationRequest {
    /// ID of the operation to cancel.
    #[prost(string, tag = "1")]
    pub operation_id: ::prost::alloc::string::String,
}
/// Generated client implementations.
pub mod operation_service_client {
    #![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
    use tonic::codegen::*;
    use tonic::codegen::http::Uri;
    /// A set of methods for managing operations for asynchronous API requests.
    #[derive(Debug, Clone)]
    pub struct OperationServiceClient<T> {
        inner: tonic::client::Grpc<T>,
    }
    impl OperationServiceClient<tonic::transport::Channel> {
        /// Attempt to create a new client by connecting to a given endpoint.
        pub async fn connect<D>(dst: D) -> Result<Self, tonic::transport::Error>
        where
            D: TryInto<tonic::transport::Endpoint>,
            D::Error: Into<StdError>,
        {
            let conn = tonic::transport::Endpoint::new(dst)?.connect().await?;
            Ok(Self::new(conn))
        }
    }
    impl<T> OperationServiceClient<T>
    where
        T: tonic::client::GrpcService<tonic::body::BoxBody>,
        T::Error: Into<StdError>,
        T::ResponseBody: Body<Data = Bytes> + Send + 'static,
        <T::ResponseBody as Body>::Error: Into<StdError> + Send,
    {
        pub fn new(inner: T) -> Self {
            let inner = tonic::client::Grpc::new(inner);
            Self { inner }
        }
        pub fn with_origin(inner: T, origin: Uri) -> Self {
            let inner = tonic::client::Grpc::with_origin(inner, origin);
            Self { inner }
        }
        pub fn with_interceptor<F>(
            inner: T,
            interceptor: F,
        ) -> OperationServiceClient<InterceptedService<T, F>>
        where
            F: tonic::service::Interceptor,
            T::ResponseBody: Default,
            T: tonic::codegen::Service<
                http::Request<tonic::body::BoxBody>,
                Response = http::Response<
                    <T as tonic::client::GrpcService<tonic::body::BoxBody>>::ResponseBody,
                >,
            >,
            <T as tonic::codegen::Service<
                http::Request<tonic::body::BoxBody>,
            >>::Error: Into<StdError> + Send + Sync,
        {
            OperationServiceClient::new(InterceptedService::new(inner, interceptor))
        }
        /// Compress requests with the given encoding.
        ///
        /// This requires the server to support it otherwise it might respond with an
        /// error.
        #[must_use]
        pub fn send_compressed(mut self, encoding: CompressionEncoding) -> Self {
            self.inner = self.inner.send_compressed(encoding);
            self
        }
        /// Enable decompressing responses.
        #[must_use]
        pub fn accept_compressed(mut self, encoding: CompressionEncoding) -> Self {
            self.inner = self.inner.accept_compressed(encoding);
            self
        }
        /// Limits the maximum size of a decoded message.
        ///
        /// Default: `4MB`
        #[must_use]
        pub fn max_decoding_message_size(mut self, limit: usize) -> Self {
            self.inner = self.inner.max_decoding_message_size(limit);
            self
        }
        /// Limits the maximum size of an encoded message.
        ///
        /// Default: `usize::MAX`
        #[must_use]
        pub fn max_encoding_message_size(mut self, limit: usize) -> Self {
            self.inner = self.inner.max_encoding_message_size(limit);
            self
        }
        /// Returns the specified Operation resource.
        pub async fn get(
            &mut self,
            request: impl tonic::IntoRequest<super::GetOperationRequest>,
        ) -> std::result::Result<tonic::Response<super::Operation>, tonic::Status> {
            self.inner
                .ready()
                .await
                .map_err(|e| {
                    tonic::Status::new(
                        tonic::Code::Unknown,
                        format!("Service was not ready: {}", e.into()),
                    )
                })?;
            let codec = tonic::codec::ProstCodec::default();
            let path = http::uri::PathAndQuery::from_static(
                "/yandex.cloud.operation.OperationService/Get",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(
                    GrpcMethod::new("yandex.cloud.operation.OperationService", "Get"),
                );
            self.inner.unary(req, path, codec).await
        }
        /// Cancels the specified operation.
        ///
        /// Note that currently Object Storage API does not support cancelling operations.
        pub async fn cancel(
            &mut self,
            request: impl tonic::IntoRequest<super::CancelOperationRequest>,
        ) -> std::result::Result<tonic::Response<super::Operation>, tonic::Status> {
            self.inner
                .ready()
                .await
                .map_err(|e| {
                    tonic::Status::new(
                        tonic::Code::Unknown,
                        format!("Service was not ready: {}", e.into()),
                    )
                })?;
            let codec = tonic::codec::ProstCodec::default();
            let path = http::uri::PathAndQuery::from_static(
                "/yandex.cloud.operation.OperationService/Cancel",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(
                    GrpcMethod::new("yandex.cloud.operation.OperationService", "Cancel"),
                );
            self.inner.unary(req, path, codec).await
        }
    }
}