nominal-api 0.1194.0

API bindings for the Nominal platform
Documentation
// This file is @generated by prost-build.
/// This is used to identify any type of blob that will be in object storage.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ResourceIdentifier {
    #[prost(string, tag = "1")]
    pub rid: ::prost::alloc::string::String,
}
/// file_name and owning_rid should be consistent across all requests for a byte stream
/// permission on the uploaded blob is tied to associated owning_rid
/// when making a call to upload stream request, the assumption is that the user already has
/// auth on the owning_rid, and we will throw a permission error if this doesn't hold
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UploadBlobStreamRequest {
    #[prost(message, optional, tag = "1")]
    pub owning_rid: ::core::option::Option<ResourceIdentifier>,
    #[prost(string, tag = "2")]
    pub file_name: ::prost::alloc::string::String,
    /// when set to true, ensure_unique will attach the current timestamp to the file name
    /// this will ensure that we do not overwrite an existing file in blob storage
    #[prost(bool, tag = "3")]
    pub ensure_unique: bool,
    #[prost(bytes = "vec", tag = "4")]
    pub content: ::prost::alloc::vec::Vec<u8>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UploadBlobStreamResponse {
    /// This is the key that can be used in a retrieve blob request in order
    /// to retrieve this specific blob. If ensure_unique is not set, this will match
    /// the file name provided in UploadBlobStreamRequest
    #[prost(string, tag = "1")]
    pub file_name: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetSignedUrlForBlobRequest {
    #[prost(message, optional, tag = "1")]
    pub owning_rid: ::core::option::Option<ResourceIdentifier>,
    #[prost(string, tag = "2")]
    pub file_name: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetSignedUrlForBlobResponse {
    /// This is a short lived signed url that can be used by the client to retrieve
    /// the object
    #[prost(string, tag = "1")]
    pub url: ::prost::alloc::string::String,
}
/// Generated client implementations.
pub mod blob_storage_service_client {
    #![allow(
        unused_variables,
        dead_code,
        missing_docs,
        clippy::wildcard_imports,
        clippy::let_unit_value,
    )]
    use tonic::codegen::*;
    use tonic::codegen::http::Uri;
    /// Service for storing and retrieving blobs in object storage with workspace-based authorization.
    #[derive(Debug, Clone)]
    pub struct BlobStorageServiceClient<T> {
        inner: tonic::client::Grpc<T>,
    }
    impl BlobStorageServiceClient<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> BlobStorageServiceClient<T>
    where
        T: tonic::client::GrpcService<tonic::body::Body>,
        T::Error: Into<StdError>,
        T::ResponseBody: Body<Data = Bytes> + std::marker::Send + 'static,
        <T::ResponseBody as Body>::Error: Into<StdError> + std::marker::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,
        ) -> BlobStorageServiceClient<InterceptedService<T, F>>
        where
            F: tonic::service::Interceptor,
            T::ResponseBody: Default,
            T: tonic::codegen::Service<
                http::Request<tonic::body::Body>,
                Response = http::Response<
                    <T as tonic::client::GrpcService<tonic::body::Body>>::ResponseBody,
                >,
            >,
            <T as tonic::codegen::Service<
                http::Request<tonic::body::Body>,
            >>::Error: Into<StdError> + std::marker::Send + std::marker::Sync,
        {
            BlobStorageServiceClient::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
        }
        /// Upload a blob using streaming. The blob will be stored with authorization checks
        /// based on the provided owningRid.
        pub async fn upload_blob_stream(
            &mut self,
            request: impl tonic::IntoStreamingRequest<
                Message = super::UploadBlobStreamRequest,
            >,
        ) -> std::result::Result<
            tonic::Response<super::UploadBlobStreamResponse>,
            tonic::Status,
        > {
            self.inner
                .ready()
                .await
                .map_err(|e| {
                    tonic::Status::unknown(
                        format!("Service was not ready: {}", e.into()),
                    )
                })?;
            let codec = tonic::codec::ProstCodec::default();
            let path = http::uri::PathAndQuery::from_static(
                "/nominal.blob_storage_service.v1.BlobStorageService/UploadBlobStream",
            );
            let mut req = request.into_streaming_request();
            req.extensions_mut()
                .insert(
                    GrpcMethod::new(
                        "nominal.blob_storage_service.v1.BlobStorageService",
                        "UploadBlobStream",
                    ),
                );
            self.inner.client_streaming(req, path, codec).await
        }
        /// Retrieve a signed URL for downloading a blob. The URL is valid for 15 minutes.
        pub async fn get_signed_url_for_blob(
            &mut self,
            request: impl tonic::IntoRequest<super::GetSignedUrlForBlobRequest>,
        ) -> std::result::Result<
            tonic::Response<super::GetSignedUrlForBlobResponse>,
            tonic::Status,
        > {
            self.inner
                .ready()
                .await
                .map_err(|e| {
                    tonic::Status::unknown(
                        format!("Service was not ready: {}", e.into()),
                    )
                })?;
            let codec = tonic::codec::ProstCodec::default();
            let path = http::uri::PathAndQuery::from_static(
                "/nominal.blob_storage_service.v1.BlobStorageService/GetSignedUrlForBlob",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(
                    GrpcMethod::new(
                        "nominal.blob_storage_service.v1.BlobStorageService",
                        "GetSignedUrlForBlob",
                    ),
                );
            self.inner.unary(req, path, codec).await
        }
    }
}