nominal-api 0.1196.0

// This file is @generated by prost-build.
/// Authentication configuration for OPC-UA server connection
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OpcAuthenticationConfig {
    #[prost(
        oneof = "opc_authentication_config::OpcAuthenticationConfig",
        tags = "1, 2, 3"
    )]
    pub opc_authentication_config: ::core::option::Option<
        opc_authentication_config::OpcAuthenticationConfig,
    >,
}
/// Nested message and enum types in `OpcAuthenticationConfig`.
pub mod opc_authentication_config {
    #[derive(Clone, PartialEq, ::prost::Oneof)]
    pub enum OpcAuthenticationConfig {
        #[prost(message, tag = "1")]
        Anonymous(super::super::super::super::google::protobuf::Empty),
        #[prost(message, tag = "2")]
        UsernamePassword(super::OpcUsernamePasswordAuthentication),
        #[prost(message, tag = "3")]
        Token(super::OpcTokenAuthentication),
    }
}
/// Authentication configuration for OPC-UA server connection with secrets
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OpcAuthenticationConfigSecret {
    #[prost(
        oneof = "opc_authentication_config_secret::OpcAuthenticationConfig",
        tags = "1, 2, 3"
    )]
    pub opc_authentication_config: ::core::option::Option<
        opc_authentication_config_secret::OpcAuthenticationConfig,
    >,
}
/// Nested message and enum types in `OpcAuthenticationConfigSecret`.
pub mod opc_authentication_config_secret {
    #[derive(Clone, PartialEq, ::prost::Oneof)]
    pub enum OpcAuthenticationConfig {
        #[prost(message, tag = "1")]
        Anonymous(super::super::super::super::google::protobuf::Empty),
        #[prost(message, tag = "2")]
        UsernamePassword(super::OpcUsernamePasswordAuthenticationSecret),
        #[prost(message, tag = "3")]
        Token(super::OpcTokenAuthenticationSecret),
    }
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OpcUsernamePasswordAuthentication {
    #[prost(string, tag = "1")]
    pub username: ::prost::alloc::string::String,
    #[prost(string, tag = "2")]
    pub password: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OpcUsernamePasswordAuthenticationSecret {
    #[prost(string, tag = "1")]
    pub username: ::prost::alloc::string::String,
    #[prost(string, tag = "2")]
    pub password: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OpcTokenAuthentication {
    #[prost(string, tag = "1")]
    pub token: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OpcTokenAuthenticationSecret {
    #[prost(string, tag = "1")]
    pub token: ::prost::alloc::string::String,
}
/// The identifier field for an OPC-UA node
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OpcIdentifierValue {
    #[prost(oneof = "opc_identifier_value::OpcIdentifierValue", tags = "1, 2")]
    pub opc_identifier_value: ::core::option::Option<
        opc_identifier_value::OpcIdentifierValue,
    >,
}
/// Nested message and enum types in `OpcIdentifierValue`.
pub mod opc_identifier_value {
    #[derive(Clone, PartialEq, ::prost::Oneof)]
    pub enum OpcIdentifierValue {
        #[prost(int32, tag = "1")]
        Numeric(i32),
        #[prost(string, tag = "2")]
        String(::prost::alloc::string::String),
    }
}
/// An OPC-UA node
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OpcNode {
    #[prost(uint32, optional, tag = "1")]
    pub namespace: ::core::option::Option<u32>,
    #[prost(message, optional, tag = "2")]
    pub identifier: ::core::option::Option<OpcIdentifierValue>,
}
/// How do you want to map the names of OPC-UA nodes to Nominal channels?
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OpcUaChannelNamingConvention {
    #[prost(
        oneof = "opc_ua_channel_naming_convention::NamingConvention",
        tags = "1, 2, 3, 4"
    )]
    pub naming_convention: ::core::option::Option<
        opc_ua_channel_naming_convention::NamingConvention,
    >,
}
/// Nested message and enum types in `OpcUaChannelNamingConvention`.
pub mod opc_ua_channel_naming_convention {
    #[derive(Clone, Copy, PartialEq, ::prost::Message)]
    pub struct OpcUaNodeId {}
    #[derive(Clone, Copy, PartialEq, ::prost::Message)]
    pub struct OpcUaBrowseName {}
    #[derive(Clone, Copy, PartialEq, ::prost::Message)]
    pub struct OpcUaDisplayName {}
    /// Configuration for full path naming convention
    #[derive(Clone, PartialEq, ::prost::Message)]
    pub struct OpcUaFullPath {
        /// We will build path up to any of these nodes, or the Objects folder.
        #[prost(message, repeated, tag = "1")]
        pub root_nodes: ::prost::alloc::vec::Vec<super::OpcNode>,
        /// Custom delimiter for path separation. Defaults to "/" if not specified.
        #[prost(string, tag = "2")]
        pub delimiter: ::prost::alloc::string::String,
    }
    #[derive(Clone, PartialEq, ::prost::Oneof)]
    pub enum NamingConvention {
        /// For example, "NodeId{ns=3;i=1010}"
        #[prost(message, tag = "1")]
        NodeId(OpcUaNodeId),
        /// The "name" field under the "BrowseName" attribute
        #[prost(message, tag = "2")]
        BrowseName(OpcUaBrowseName),
        /// The "text" field under the "DisplayName" attribute
        #[prost(message, tag = "3")]
        DisplayName(OpcUaDisplayName),
        /// The full path of the node, separated by a delimiter. Use this setting for creating the hierarchical prefix tree.
        #[prost(message, tag = "4")]
        FullPath(OpcUaFullPath),
    }
}
/// Configuration for connecting to an OPC-UA server
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OpcUaConnectionDetails {
    #[prost(string, tag = "1")]
    pub uri: ::prost::alloc::string::String,
    #[prost(enumeration = "OpcSecurityPolicy", tag = "2")]
    pub security_policy: i32,
    #[prost(message, optional, tag = "3")]
    pub authentication_config: ::core::option::Option<OpcAuthenticationConfig>,
}
/// Configuration for connecting to an OPC-UA server with secrets
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OpcUaConnectionDetailsSecret {
    #[prost(string, tag = "1")]
    pub uri: ::prost::alloc::string::String,
    #[prost(enumeration = "OpcSecurityPolicy", tag = "2")]
    pub security_policy: i32,
    #[prost(message, optional, tag = "3")]
    pub authentication_config: ::core::option::Option<OpcAuthenticationConfigSecret>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OpcUaTraversalConfig {
    /// Root nodes to subscribe to. For each node specified here, we will
    /// subscribe to that node and all of its children.
    #[prost(message, repeated, tag = "1")]
    pub root_nodes: ::prost::alloc::vec::Vec<OpcNode>,
    /// We will not subscribe to any of these nodes.
    #[prost(message, repeated, tag = "2")]
    pub skip_nodes: ::prost::alloc::vec::Vec<OpcNode>,
    /// The type of references that we will follow when traversing the root nodes in the OPC UA server.
    #[prost(enumeration = "OpcUaReferenceExplorationType", tag = "3")]
    pub reference_exploration_type: i32,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OpcUaDirectNodeSubscription {
    #[prost(message, repeated, tag = "1")]
    pub nodes: ::prost::alloc::vec::Vec<OpcNode>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OpcUaNodeExplorationConfig {
    #[prost(
        oneof = "opc_ua_node_exploration_config::OpcUaNodeExplorationConfig",
        tags = "1, 2"
    )]
    pub opc_ua_node_exploration_config: ::core::option::Option<
        opc_ua_node_exploration_config::OpcUaNodeExplorationConfig,
    >,
}
/// Nested message and enum types in `OpcUaNodeExplorationConfig`.
pub mod opc_ua_node_exploration_config {
    #[derive(Clone, PartialEq, ::prost::Oneof)]
    pub enum OpcUaNodeExplorationConfig {
        #[prost(message, tag = "1")]
        OpcUaTraversalConfig(super::OpcUaTraversalConfig),
        #[prost(message, tag = "2")]
        OpcUaDirectNodeSubscription(super::OpcUaDirectNodeSubscription),
    }
}
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct OpcUaTimestampHandling {
    #[prost(oneof = "opc_ua_timestamp_handling::TimestampType", tags = "1, 2, 3")]
    pub timestamp_type: ::core::option::Option<opc_ua_timestamp_handling::TimestampType>,
}
/// Nested message and enum types in `OpcUaTimestampHandling`.
pub mod opc_ua_timestamp_handling {
    /// Use the server timestamp <https://reference.opcfoundation.org/Core/Part4/v104/docs/7.7.4>
    #[derive(Clone, Copy, PartialEq, ::prost::Message)]
    pub struct OpcUaServerTime {}
    /// Use the source timestamp <https://reference.opcfoundation.org/Core/Part4/v104/docs/7.7.3>
    #[derive(Clone, Copy, PartialEq, ::prost::Message)]
    pub struct OpcUaSourceTime {}
    /// Use the server timestamp, but add an an optional offset. By default, the offset will be the time now.
    /// This is useful for when the server starts at an epoch time of 0.
    #[derive(Clone, Copy, PartialEq, ::prost::Message)]
    pub struct OpcUaRelativeTimestamp {
        #[prost(message, optional, tag = "1")]
        pub offset: ::core::option::Option<
            super::super::super::super::google::protobuf::Timestamp,
        >,
    }
    #[derive(Clone, Copy, PartialEq, ::prost::Oneof)]
    pub enum TimestampType {
        #[prost(message, tag = "1")]
        Server(OpcUaServerTime),
        #[prost(message, tag = "2")]
        Source(OpcUaSourceTime),
        #[prost(message, tag = "3")]
        Relative(OpcUaRelativeTimestamp),
    }
}
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct OpcUaDataChangeFilter {
    /// The trigger for the data change filter.
    #[prost(enumeration = "OpcUaDataChangeTrigger", tag = "1")]
    pub trigger: i32,
    #[prost(enumeration = "OpcUaDeadbandType", tag = "2")]
    pub deadband_type: i32,
    #[prost(double, tag = "3")]
    pub deadband_value: f64,
}
/// Configuration for determining which nodes to scrape and how.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OpcUaScrapingConfig {
    #[prost(message, optional, tag = "1")]
    pub node_exploration_config: ::core::option::Option<OpcUaNodeExplorationConfig>,
    /// The browse name of the node under which the unit is stored for the nodes we scrape.
    #[prost(string, tag = "2")]
    pub unit_node_name: ::prost::alloc::string::String,
    #[prost(message, optional, tag = "3")]
    pub channel_naming_convention: ::core::option::Option<OpcUaChannelNamingConvention>,
    /// If true, we will override the host and port of the OPC UA server with the host and port of the original server URL.
    #[prost(bool, tag = "4")]
    pub override_host: bool,
    /// How we will handle unknown data types when we read them from the server
    #[prost(enumeration = "OpcUaUnknownDataTypeHandling", tag = "5")]
    pub unknown_data_type_handling: i32,
    /// How to handle situations where there are failed monitors.
    #[prost(enumeration = "OpcUaFailedMonitorHandling", tag = "6")]
    pub failed_monitor_handling: i32,
    /// What timestamps should we write for the channels?
    #[prost(message, optional, tag = "7")]
    pub timestamp_handling: ::core::option::Option<OpcUaTimestampHandling>,
    /// The data change filter to be applied for the monitored items in the subscription.
    #[prost(message, optional, tag = "8")]
    pub data_change_filter: ::core::option::Option<OpcUaDataChangeFilter>,
}
/// Security policies supported for OPC-UA connections
/// buf:lint:ignore ENUM_VALUE_PREFIX
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum OpcSecurityPolicy {
    Unspecified = 0,
    None = 1,
}
impl OpcSecurityPolicy {
    /// 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 => "OPC_SECURITY_POLICY_UNSPECIFIED",
            Self::None => "NONE",
        }
    }
    /// Creates an enum from field names used in the ProtoBuf definition.
    pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
        match value {
            "OPC_SECURITY_POLICY_UNSPECIFIED" => Some(Self::Unspecified),
            "NONE" => Some(Self::None),
            _ => None,
        }
    }
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum OpcUaReferenceExplorationType {
    Unspecified = 0,
    Organizes = 1,
    HierarchicalReferences = 2,
}
impl OpcUaReferenceExplorationType {
    /// 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 => "OPC_UA_REFERENCE_EXPLORATION_TYPE_UNSPECIFIED",
            Self::Organizes => "OPC_UA_REFERENCE_EXPLORATION_TYPE_ORGANIZES",
            Self::HierarchicalReferences => {
                "OPC_UA_REFERENCE_EXPLORATION_TYPE_HIERARCHICAL_REFERENCES"
            }
        }
    }
    /// Creates an enum from field names used in the ProtoBuf definition.
    pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
        match value {
            "OPC_UA_REFERENCE_EXPLORATION_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
            "OPC_UA_REFERENCE_EXPLORATION_TYPE_ORGANIZES" => Some(Self::Organizes),
            "OPC_UA_REFERENCE_EXPLORATION_TYPE_HIERARCHICAL_REFERENCES" => {
                Some(Self::HierarchicalReferences)
            }
            _ => None,
        }
    }
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum OpcUaUnknownDataTypeHandling {
    Unspecified = 0,
    /// If we encounter an unknown data type, we will error out
    Error = 1,
    /// If we encounter an unknown data type, we will assume it is a double
    TreatAsDouble = 2,
    /// If we encounter an unknown data type, we will assume it is a string
    TreatAsString = 3,
}
impl OpcUaUnknownDataTypeHandling {
    /// 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 => "OPC_UA_UNKNOWN_DATA_TYPE_HANDLING_UNSPECIFIED",
            Self::Error => "OPC_UA_UNKNOWN_DATA_TYPE_HANDLING_ERROR",
            Self::TreatAsDouble => "OPC_UA_UNKNOWN_DATA_TYPE_HANDLING_TREAT_AS_DOUBLE",
            Self::TreatAsString => "OPC_UA_UNKNOWN_DATA_TYPE_HANDLING_TREAT_AS_STRING",
        }
    }
    /// Creates an enum from field names used in the ProtoBuf definition.
    pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
        match value {
            "OPC_UA_UNKNOWN_DATA_TYPE_HANDLING_UNSPECIFIED" => Some(Self::Unspecified),
            "OPC_UA_UNKNOWN_DATA_TYPE_HANDLING_ERROR" => Some(Self::Error),
            "OPC_UA_UNKNOWN_DATA_TYPE_HANDLING_TREAT_AS_DOUBLE" => {
                Some(Self::TreatAsDouble)
            }
            "OPC_UA_UNKNOWN_DATA_TYPE_HANDLING_TREAT_AS_STRING" => {
                Some(Self::TreatAsString)
            }
            _ => None,
        }
    }
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum OpcUaFailedMonitorHandling {
    Unspecified = 0,
    Error = 1,
    Ignore = 2,
}
impl OpcUaFailedMonitorHandling {
    /// 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 => "OPC_UA_FAILED_MONITOR_HANDLING_UNSPECIFIED",
            Self::Error => "OPC_UA_FAILED_MONITOR_HANDLING_ERROR",
            Self::Ignore => "OPC_UA_FAILED_MONITOR_HANDLING_IGNORE",
        }
    }
    /// Creates an enum from field names used in the ProtoBuf definition.
    pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
        match value {
            "OPC_UA_FAILED_MONITOR_HANDLING_UNSPECIFIED" => Some(Self::Unspecified),
            "OPC_UA_FAILED_MONITOR_HANDLING_ERROR" => Some(Self::Error),
            "OPC_UA_FAILED_MONITOR_HANDLING_IGNORE" => Some(Self::Ignore),
            _ => None,
        }
    }
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum OpcUaDataChangeTrigger {
    Unspecified = 0,
    StatusOnly = 1,
    StatusValue = 2,
    StatusValueTimestamp = 3,
}
impl OpcUaDataChangeTrigger {
    /// 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 => "OPC_UA_DATA_CHANGE_TRIGGER_UNSPECIFIED",
            Self::StatusOnly => "OPC_UA_DATA_CHANGE_TRIGGER_STATUS_ONLY",
            Self::StatusValue => "OPC_UA_DATA_CHANGE_TRIGGER_STATUS_VALUE",
            Self::StatusValueTimestamp => {
                "OPC_UA_DATA_CHANGE_TRIGGER_STATUS_VALUE_TIMESTAMP"
            }
        }
    }
    /// Creates an enum from field names used in the ProtoBuf definition.
    pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
        match value {
            "OPC_UA_DATA_CHANGE_TRIGGER_UNSPECIFIED" => Some(Self::Unspecified),
            "OPC_UA_DATA_CHANGE_TRIGGER_STATUS_ONLY" => Some(Self::StatusOnly),
            "OPC_UA_DATA_CHANGE_TRIGGER_STATUS_VALUE" => Some(Self::StatusValue),
            "OPC_UA_DATA_CHANGE_TRIGGER_STATUS_VALUE_TIMESTAMP" => {
                Some(Self::StatusValueTimestamp)
            }
            _ => None,
        }
    }
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum OpcUaDeadbandType {
    Unspecified = 0,
    None = 1,
    Absolute = 2,
    Percent = 3,
}
impl OpcUaDeadbandType {
    /// 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 => "OPC_UA_DEADBAND_TYPE_UNSPECIFIED",
            Self::None => "OPC_UA_DEADBAND_TYPE_NONE",
            Self::Absolute => "OPC_UA_DEADBAND_TYPE_ABSOLUTE",
            Self::Percent => "OPC_UA_DEADBAND_TYPE_PERCENT",
        }
    }
    /// Creates an enum from field names used in the ProtoBuf definition.
    pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
        match value {
            "OPC_UA_DEADBAND_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
            "OPC_UA_DEADBAND_TYPE_NONE" => Some(Self::None),
            "OPC_UA_DEADBAND_TYPE_ABSOLUTE" => Some(Self::Absolute),
            "OPC_UA_DEADBAND_TYPE_PERCENT" => Some(Self::Percent),
            _ => None,
        }
    }
}