nominal-api 0.1200.0

API bindings for the Nominal platform
Documentation
// This file is @generated by prost-build.
/// A resource-opened event.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ResourceOpenedEvent {
    /// The type of resource that was opened.
    #[prost(enumeration = "ResourceType", tag = "1")]
    pub resource_type: i32,
    /// The RID of the resource that was opened.
    #[prost(string, tag = "2")]
    pub rid: ::prost::alloc::string::String,
    /// Whether the current user is the creator of the resource.
    #[prost(bool, tag = "3")]
    pub is_creator: bool,
}
/// Request to track a usage event.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TrackEventRequest {
    /// The workspace in which the event occurred.
    #[prost(string, tag = "1")]
    pub workspace_rid: ::prost::alloc::string::String,
    /// The event to track. Exactly one must be set.
    #[prost(oneof = "track_event_request::Event", tags = "2")]
    pub event: ::core::option::Option<track_event_request::Event>,
}
/// Nested message and enum types in `TrackEventRequest`.
pub mod track_event_request {
    /// The event to track. Exactly one must be set.
    #[derive(Clone, PartialEq, ::prost::Oneof)]
    pub enum Event {
        #[prost(message, tag = "2")]
        ResourceOpened(super::ResourceOpenedEvent),
    }
}
/// Response for tracking a usage event.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct TrackEventResponse {}
/// The type of resource involved in a usage tracking event.
/// buf:lint:ignore ENUM_VALUE_PREFIX
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum ResourceType {
    Unspecified = 0,
    Workbook = 1,
    Checklist = 2,
    Procedure = 3,
}
impl ResourceType {
    /// String value of the enum field names used in the ProtoBuf definition.
    ///
    /// The values are not transformed in any way and thus are considered stable
    /// (if the ProtoBuf definition does not change) and safe for programmatic use.
    pub fn as_str_name(&self) -> &'static str {
        match self {
            Self::Unspecified => "RESOURCE_TYPE_UNSPECIFIED",
            Self::Workbook => "RESOURCE_TYPE_WORKBOOK",
            Self::Checklist => "RESOURCE_TYPE_CHECKLIST",
            Self::Procedure => "RESOURCE_TYPE_PROCEDURE",
        }
    }
    /// Creates an enum from field names used in the ProtoBuf definition.
    pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
        match value {
            "RESOURCE_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
            "RESOURCE_TYPE_WORKBOOK" => Some(Self::Workbook),
            "RESOURCE_TYPE_CHECKLIST" => Some(Self::Checklist),
            "RESOURCE_TYPE_PROCEDURE" => Some(Self::Procedure),
            _ => None,
        }
    }
}
/// Generated client implementations.
pub mod usage_tracking_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 tracking usage events from the frontend.
    #[derive(Debug, Clone)]
    pub struct UsageTrackingServiceClient<T> {
        inner: tonic::client::Grpc<T>,
    }
    impl UsageTrackingServiceClient<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> UsageTrackingServiceClient<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,
        ) -> UsageTrackingServiceClient<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,
        {
            UsageTrackingServiceClient::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
        }
        /// Tracks a usage event. Accepts an event with associated metadata and publishes
        /// it as an internal usage tracking metric.
        pub async fn track_event(
            &mut self,
            request: impl tonic::IntoRequest<super::TrackEventRequest>,
        ) -> std::result::Result<
            tonic::Response<super::TrackEventResponse>,
            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.usage_tracking.v1.UsageTrackingService/TrackEvent",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(
                    GrpcMethod::new(
                        "nominal.usage_tracking.v1.UsageTrackingService",
                        "TrackEvent",
                    ),
                );
            self.inner.unary(req, path, codec).await
        }
    }
}