nominal-api 0.1196.0

API bindings for the Nominal platform
Documentation
// This file is @generated by prost-build.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct Empty {}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ErrorResult {
    #[prost(string, tag = "1")]
    pub error_type: ::prost::alloc::string::String,
    #[prost(string, tag = "2")]
    pub message: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Handle {
    #[prost(oneof = "handle::Handle", tags = "1")]
    pub handle: ::core::option::Option<handle::Handle>,
}
/// Nested message and enum types in `Handle`.
pub mod handle {
    #[derive(Clone, PartialEq, ::prost::Oneof)]
    pub enum Handle {
        #[prost(string, tag = "1")]
        S3(::prost::alloc::string::String),
    }
}
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct InProgressResult {}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct IngestStatusV2 {
    #[prost(oneof = "ingest_status_v2::IngestStatusV2", tags = "1, 2, 3")]
    pub ingest_status_v2: ::core::option::Option<ingest_status_v2::IngestStatusV2>,
}
/// Nested message and enum types in `IngestStatusV2`.
pub mod ingest_status_v2 {
    #[derive(Clone, PartialEq, ::prost::Oneof)]
    pub enum IngestStatusV2 {
        #[prost(message, tag = "1")]
        Success(super::SuccessResult),
        #[prost(message, tag = "2")]
        Error(super::ErrorResult),
        #[prost(message, tag = "3")]
        InProgress(super::InProgressResult),
    }
}
/// Locator for a channel in an mcap file. Channel name is not guaranteed to be unique, so channel ID should
/// be used for mcap files with duplicate channel names.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct McapChannelLocator {
    /// Locator for a channel in an mcap file. Channel name is not guaranteed to be unique, so channel ID should
    /// be used for mcap files with duplicate channel names.
    #[prost(oneof = "mcap_channel_locator::McapChannelLocator", tags = "1, 2")]
    pub mcap_channel_locator: ::core::option::Option<
        mcap_channel_locator::McapChannelLocator,
    >,
}
/// Nested message and enum types in `McapChannelLocator`.
pub mod mcap_channel_locator {
    /// Locator for a channel in an mcap file. Channel name is not guaranteed to be unique, so channel ID should
    /// be used for mcap files with duplicate channel names.
    #[derive(Clone, PartialEq, ::prost::Oneof)]
    pub enum McapChannelLocator {
        #[prost(string, tag = "1")]
        Topic(::prost::alloc::string::String),
        #[prost(int32, tag = "2")]
        Id(i32),
    }
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Property {
    #[prost(string, tag = "1")]
    pub name: ::prost::alloc::string::String,
    #[prost(string, tag = "2")]
    pub value: ::prost::alloc::string::String,
}
/// Wrapper classes to allow for optional fields on update requests
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct LabelUpdateWrapper {
    #[prost(string, repeated, tag = "1")]
    pub labels: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PropertyUpdateWrapper {
    #[prost(map = "string, string", tag = "1")]
    pub properties: ::std::collections::HashMap<
        ::prost::alloc::string::String,
        ::prost::alloc::string::String,
    >,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RefNameAndType {
    #[prost(string, tag = "1")]
    pub name: ::prost::alloc::string::String,
    #[prost(enumeration = "DataSourceType", tag = "2")]
    pub r#type: i32,
}
/// A SerializableError is a representation of a ServiceException that exists to send error
/// results to clients as part of a response object when directly throwing an exception is undesirable.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SerializableError {
    #[prost(string, tag = "1")]
    pub name: ::prost::alloc::string::String,
    #[prost(string, optional, tag = "2")]
    pub message: ::core::option::Option<::prost::alloc::string::String>,
    #[prost(string, tag = "3")]
    pub error_instance_id: ::prost::alloc::string::String,
    #[prost(int32, tag = "4")]
    pub status_code: i32,
    #[prost(map = "string, string", tag = "5")]
    pub params: ::std::collections::HashMap<
        ::prost::alloc::string::String,
        ::prost::alloc::string::String,
    >,
}
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct SuccessResult {}
/// buf:lint:ignore ENUM_VALUE_PREFIX
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum ArchivedStatus {
    Unspecified = 0,
    NotArchived = 1,
    Archived = 2,
}
impl ArchivedStatus {
    /// 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 => "ARCHIVED_STATUS_UNSPECIFIED",
            Self::NotArchived => "NOT_ARCHIVED",
            Self::Archived => "ARCHIVED",
        }
    }
    /// Creates an enum from field names used in the ProtoBuf definition.
    pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
        match value {
            "ARCHIVED_STATUS_UNSPECIFIED" => Some(Self::Unspecified),
            "NOT_ARCHIVED" => Some(Self::NotArchived),
            "ARCHIVED" => Some(Self::Archived),
            _ => None,
        }
    }
}
/// buf:lint:ignore ENUM_VALUE_PREFIX
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum DataSourceType {
    Unspecified = 0,
    Dataset = 1,
    Connection = 2,
    Video = 3,
}
impl DataSourceType {
    /// 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 => "DATA_SOURCE_TYPE_UNSPECIFIED",
            Self::Dataset => "DATASET",
            Self::Connection => "CONNECTION",
            Self::Video => "VIDEO",
        }
    }
    /// Creates an enum from field names used in the ProtoBuf definition.
    pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
        match value {
            "DATA_SOURCE_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
            "DATASET" => Some(Self::Dataset),
            "CONNECTION" => Some(Self::Connection),
            "VIDEO" => Some(Self::Video),
            _ => None,
        }
    }
}
/// buf:lint:ignore ENUM_VALUE_PREFIX
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum Granularity {
    Unspecified = 0,
    Nanoseconds = 2,
}
impl Granularity {
    /// 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 => "GRANULARITY_UNSPECIFIED",
            Self::Nanoseconds => "NANOSECONDS",
        }
    }
    /// Creates an enum from field names used in the ProtoBuf definition.
    pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
        match value {
            "GRANULARITY_UNSPECIFIED" => Some(Self::Unspecified),
            "NANOSECONDS" => Some(Self::Nanoseconds),
            _ => None,
        }
    }
}
/// buf:lint:ignore ENUM_VALUE_PREFIX
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum IngestStatus {
    Unspecified = 0,
    Succeeded = 1,
    Failed = 2,
    InProgress = 3,
    DeletionInProgress = 4,
    Deleted = 5,
}
impl IngestStatus {
    /// 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 => "INGEST_STATUS_UNSPECIFIED",
            Self::Succeeded => "SUCCEEDED",
            Self::Failed => "FAILED",
            Self::InProgress => "IN_PROGRESS",
            Self::DeletionInProgress => "DELETION_IN_PROGRESS",
            Self::Deleted => "DELETED",
        }
    }
    /// Creates an enum from field names used in the ProtoBuf definition.
    pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
        match value {
            "INGEST_STATUS_UNSPECIFIED" => Some(Self::Unspecified),
            "SUCCEEDED" => Some(Self::Succeeded),
            "FAILED" => Some(Self::Failed),
            "IN_PROGRESS" => Some(Self::InProgress),
            "DELETION_IN_PROGRESS" => Some(Self::DeletionInProgress),
            "DELETED" => Some(Self::Deleted),
            _ => None,
        }
    }
}
/// The data types supported by Nominal's database.
///
/// buf:lint:ignore ENUM_VALUE_PREFIX
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum NominalDataType {
    Unspecified = 0,
    Double = 1,
    String = 2,
    Log = 3,
    Int64 = 4,
}
impl NominalDataType {
    /// 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 => "NOMINAL_DATA_TYPE_UNSPECIFIED",
            Self::Double => "DOUBLE",
            Self::String => "STRING",
            Self::Log => "LOG",
            Self::Int64 => "INT64",
        }
    }
    /// Creates an enum from field names used in the ProtoBuf definition.
    pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
        match value {
            "NOMINAL_DATA_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
            "DOUBLE" => Some(Self::Double),
            "STRING" => Some(Self::String),
            "LOG" => Some(Self::Log),
            "INT64" => Some(Self::Int64),
            _ => None,
        }
    }
}