nominal-api 0.1206.0

// This file is @generated by prost-build.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteDataRequest {
    #[prost(string, tag = "1")]
    pub data_source_rid: ::prost::alloc::string::String,
    /// If specified, will only delete data within the given time range.
    /// If not specified, will delete data across all time.
    #[prost(message, optional, tag = "2")]
    pub time_range: ::core::option::Option<super::super::types::time::Range>,
    /// If specified, will only delete data that fully matches the given tags.
    /// If not specified, will delete data across all tags.
    #[prost(map = "string, string", tag = "3")]
    pub tags: ::std::collections::HashMap<
        ::prost::alloc::string::String,
        ::prost::alloc::string::String,
    >,
    /// If specified, will only delete data that has an exact channel name match with the given names.
    /// If not specified, will delete data across all channels.
    #[prost(string, repeated, tag = "4")]
    pub channel_names: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
    /// If true and tags, channelNames, and timeRange are empty, will also delete associated channel metadata.
    /// Otherwise, will only delete raw data. This is to guarantee that you are not orphaning data unintentionally
    /// by deleting the metadata.
    #[prost(bool, tag = "5")]
    pub delete_metadata: bool,
}
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct DeleteDataResponse {}
/// Identifies a channel with its associated tags.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ChannelWithTags {
    #[prost(string, tag = "1")]
    pub channel: ::prost::alloc::string::String,
    #[prost(map = "string, string", tag = "2")]
    pub tags: ::std::collections::HashMap<
        ::prost::alloc::string::String,
        ::prost::alloc::string::String,
    >,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteChannelWithTagsRequest {
    #[prost(string, tag = "1")]
    pub data_source_rid: ::prost::alloc::string::String,
    /// If channel is provided, only channels with tags matching that channel will be deleted.
    #[prost(string, optional, tag = "2")]
    pub channel: ::core::option::Option<::prost::alloc::string::String>,
    /// At least one tag must be specified in the request. Deletes all data containing the specified tags.
    #[prost(map = "string, string", tag = "3")]
    pub tags: ::std::collections::HashMap<
        ::prost::alloc::string::String,
        ::prost::alloc::string::String,
    >,
    /// When false, the request does not apply the deletions and instead returns the list of channels with tags
    /// that would be deleted. When true, the deletions are applied.
    #[prost(bool, tag = "4")]
    pub apply: bool,
    /// !!! WARNING !!!
    /// When true, skips the soft-delete queue and permanently makes the channel and tags combinations unviewable.
    /// This effect is IMMEDIATE and CANNOT be undone.
    /// Requires apply to be true to have any effect.
    #[prost(bool, tag = "5")]
    pub skip_hard_delete: bool,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteChannelWithTagsResponse {
    /// The list of ChannelWithTags that were deleted or would be deleted (when apply is false).
    #[prost(message, repeated, tag = "1")]
    pub channel_with_tags: ::prost::alloc::vec::Vec<ChannelWithTags>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UndeleteChannelWithTagsRequest {
    #[prost(string, tag = "1")]
    pub data_source_rid: ::prost::alloc::string::String,
    #[prost(message, repeated, tag = "2")]
    pub channel_with_tags: ::prost::alloc::vec::Vec<ChannelWithTags>,
}
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct UndeleteChannelWithTagsResponse {}
/// Generated client implementations.
pub mod data_deletion_service_client {
    #![allow(
        unused_variables,
        dead_code,
        missing_docs,
        clippy::wildcard_imports,
        clippy::let_unit_value,
    )]
    use tonic::codegen::*;
    use tonic::codegen::http::Uri;
    /// Data Deletion Service manages deletion of stored data.
    #[derive(Debug, Clone)]
    pub struct DataDeletionServiceClient<T> {
        inner: tonic::client::Grpc<T>,
    }
    impl DataDeletionServiceClient<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> DataDeletionServiceClient<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,
        ) -> DataDeletionServiceClient<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,
        {
            DataDeletionServiceClient::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
        }
        /// Deletes stored data. This is an irreversible operation so be careful about specified
        /// time range, channel names, and tag scope. requires the user to be an admin for the organization.
        pub async fn delete_data(
            &mut self,
            request: impl tonic::IntoRequest<super::DeleteDataRequest>,
        ) -> std::result::Result<
            tonic::Response<super::DeleteDataResponse>,
            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.storage.v1.DataDeletionService/DeleteData",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(
                    GrpcMethod::new(
                        "nominal.storage.v1.DataDeletionService",
                        "DeleteData",
                    ),
                );
            self.inner.unary(req, path, codec).await
        }
        /// Deletes channels with tags within a data source.
        /// Requires DATASOURCE__DELETE_DATA permission on the data source.
        /// Deletions are soft — deleted channels with tags are marked for deletion and will eventually be hard deleted.
        /// The request will be rejected if there are too many pending deletions for the data source.
        /// Throws if the request matches too many channels with tags.
        pub async fn delete_channel_with_tags(
            &mut self,
            request: impl tonic::IntoRequest<super::DeleteChannelWithTagsRequest>,
        ) -> std::result::Result<
            tonic::Response<super::DeleteChannelWithTagsResponse>,
            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.storage.v1.DataDeletionService/DeleteChannelWithTags",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(
                    GrpcMethod::new(
                        "nominal.storage.v1.DataDeletionService",
                        "DeleteChannelWithTags",
                    ),
                );
            self.inner.unary(req, path, codec).await
        }
        /// Best effort to undelete channels with tags within a data source.
        /// Requires DATASOURCE__DELETE_DATA permission on the data source.
        /// The batch size of channels with tags in the request must be <= 1000.
        pub async fn undelete_channel_with_tags(
            &mut self,
            request: impl tonic::IntoRequest<super::UndeleteChannelWithTagsRequest>,
        ) -> std::result::Result<
            tonic::Response<super::UndeleteChannelWithTagsResponse>,
            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.storage.v1.DataDeletionService/UndeleteChannelWithTags",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(
                    GrpcMethod::new(
                        "nominal.storage.v1.DataDeletionService",
                        "UndeleteChannelWithTags",
                    ),
                );
            self.inner.unary(req, path, codec).await
        }
    }
}
/// A retention exemption for a dataset, representing a time range that should be preserved
/// regardless of the dataset's retention policy.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DatasetRetentionExemption {
    /// The dataset this exemption applies to.
    #[prost(string, tag = "1")]
    pub dataset_rid: ::prost::alloc::string::String,
    /// Identifier for the source of this exemption (e.g. run RID).
    #[prost(string, tag = "2")]
    pub source_id: ::prost::alloc::string::String,
    /// Inclusive time range to exempt from retention.
    #[prost(message, optional, tag = "3")]
    pub bounds: ::core::option::Option<super::super::types::time::Range>,
    #[prost(string, optional, tag = "4")]
    pub description: ::core::option::Option<::prost::alloc::string::String>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpsertDatasetRetentionExemptionRequest {
    #[prost(string, tag = "1")]
    pub dataset_rid: ::prost::alloc::string::String,
    #[prost(string, tag = "2")]
    pub source_id: ::prost::alloc::string::String,
    /// Inclusive time range to exempt from retention.
    #[prost(message, optional, tag = "3")]
    pub bounds: ::core::option::Option<super::super::types::time::Range>,
    #[prost(string, optional, tag = "4")]
    pub description: ::core::option::Option<::prost::alloc::string::String>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpsertDatasetRetentionExemptionResponse {
    #[prost(message, optional, tag = "1")]
    pub exemption: ::core::option::Option<DatasetRetentionExemption>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteDatasetRetentionExemptionRequest {
    #[prost(string, tag = "1")]
    pub dataset_rid: ::prost::alloc::string::String,
    #[prost(string, tag = "2")]
    pub source_id: ::prost::alloc::string::String,
}
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct DeleteDatasetRetentionExemptionResponse {}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListDatasetRetentionExemptionsRequest {
    #[prost(string, tag = "1")]
    pub dataset_rid: ::prost::alloc::string::String,
    /// Filter exemptions that overlap with this time range.
    #[prost(message, optional, tag = "2")]
    pub bounds: ::core::option::Option<super::super::types::time::Range>,
    #[prost(int32, optional, tag = "3")]
    pub page_size: ::core::option::Option<i32>,
    #[prost(string, optional, tag = "4")]
    pub next_page_token: ::core::option::Option<::prost::alloc::string::String>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListDatasetRetentionExemptionsResponse {
    #[prost(message, repeated, tag = "1")]
    pub exemptions: ::prost::alloc::vec::Vec<DatasetRetentionExemption>,
    #[prost(string, optional, tag = "2")]
    pub next_page_token: ::core::option::Option<::prost::alloc::string::String>,
}
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct KeepForever {}
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct KeepUntilExpiry {
    #[prost(int32, tag = "1")]
    pub expiry_days: i32,
}
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct RetentionPolicy {
    #[prost(oneof = "retention_policy::Policy", tags = "1, 2")]
    pub policy: ::core::option::Option<retention_policy::Policy>,
}
/// Nested message and enum types in `RetentionPolicy`.
pub mod retention_policy {
    #[derive(Clone, Copy, PartialEq, ::prost::Oneof)]
    pub enum Policy {
        #[prost(message, tag = "1")]
        KeepForever(super::KeepForever),
        #[prost(message, tag = "2")]
        KeepUntilExpiry(super::KeepUntilExpiry),
    }
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateRetentionPolicyRequest {
    #[prost(string, tag = "1")]
    pub dataset_rid: ::prost::alloc::string::String,
    /// If absent, the retention policy is removed (reverts to default/keep-forever).
    #[prost(message, optional, tag = "2")]
    pub retention_policy: ::core::option::Option<RetentionPolicy>,
}
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct UpdateRetentionPolicyResponse {}
/// Generated client implementations.
pub mod dataset_retention_service_client {
    #![allow(
        unused_variables,
        dead_code,
        missing_docs,
        clippy::wildcard_imports,
        clippy::let_unit_value,
    )]
    use tonic::codegen::*;
    use tonic::codegen::http::Uri;
    /// Manages retention policies and exemptions for datasets.
    #[derive(Debug, Clone)]
    pub struct DatasetRetentionServiceClient<T> {
        inner: tonic::client::Grpc<T>,
    }
    impl DatasetRetentionServiceClient<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> DatasetRetentionServiceClient<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,
        ) -> DatasetRetentionServiceClient<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,
        {
            DatasetRetentionServiceClient::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
        }
        /// Update or remove the retention policy for a dataset. When a policy is set,
        /// data older than the policy's expiry will be deleted.
        pub async fn update_retention_policy(
            &mut self,
            request: impl tonic::IntoRequest<super::UpdateRetentionPolicyRequest>,
        ) -> std::result::Result<
            tonic::Response<super::UpdateRetentionPolicyResponse>,
            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.storage.v1.DatasetRetentionService/UpdateRetentionPolicy",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(
                    GrpcMethod::new(
                        "nominal.storage.v1.DatasetRetentionService",
                        "UpdateRetentionPolicy",
                    ),
                );
            self.inner.unary(req, path, codec).await
        }
        /// Create or update a retention exemption for a dataset. The exemption is keyed by
        /// (dataset_rid, source_id) — upserting with the same key updates the time range.
        pub async fn upsert_dataset_retention_exemption(
            &mut self,
            request: impl tonic::IntoRequest<
                super::UpsertDatasetRetentionExemptionRequest,
            >,
        ) -> std::result::Result<
            tonic::Response<super::UpsertDatasetRetentionExemptionResponse>,
            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.storage.v1.DatasetRetentionService/UpsertDatasetRetentionExemption",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(
                    GrpcMethod::new(
                        "nominal.storage.v1.DatasetRetentionService",
                        "UpsertDatasetRetentionExemption",
                    ),
                );
            self.inner.unary(req, path, codec).await
        }
        /// Delete a retention exemption for a dataset.
        pub async fn delete_dataset_retention_exemption(
            &mut self,
            request: impl tonic::IntoRequest<
                super::DeleteDatasetRetentionExemptionRequest,
            >,
        ) -> std::result::Result<
            tonic::Response<super::DeleteDatasetRetentionExemptionResponse>,
            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.storage.v1.DatasetRetentionService/DeleteDatasetRetentionExemption",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(
                    GrpcMethod::new(
                        "nominal.storage.v1.DatasetRetentionService",
                        "DeleteDatasetRetentionExemption",
                    ),
                );
            self.inner.unary(req, path, codec).await
        }
        /// List retention exemptions for a dataset, filtered to those overlapping the given time range.
        pub async fn list_dataset_retention_exemptions(
            &mut self,
            request: impl tonic::IntoRequest<
                super::ListDatasetRetentionExemptionsRequest,
            >,
        ) -> std::result::Result<
            tonic::Response<super::ListDatasetRetentionExemptionsResponse>,
            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.storage.v1.DatasetRetentionService/ListDatasetRetentionExemptions",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(
                    GrpcMethod::new(
                        "nominal.storage.v1.DatasetRetentionService",
                        "ListDatasetRetentionExemptions",
                    ),
                );
            self.inner.unary(req, path, codec).await
        }
    }
}