nominal-api 0.1239.0

API bindings for the Nominal platform
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
// This file is @generated by prost-build.
#[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),
    }
}
#[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,
}
#[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),
    }
}
#[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>,
}
#[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 {}
    #[derive(Clone, PartialEq, ::prost::Message)]
    pub struct OpcUaFullPath {
        #[prost(message, repeated, tag = "1")]
        pub root_nodes: ::prost::alloc::vec::Vec<super::OpcNode>,
        #[prost(string, tag = "2")]
        pub delimiter: ::prost::alloc::string::String,
    }
    #[derive(Clone, PartialEq, ::prost::Oneof)]
    pub enum NamingConvention {
        #[prost(message, tag = "1")]
        NodeId(OpcUaNodeId),
        #[prost(message, tag = "2")]
        BrowseName(OpcUaBrowseName),
        #[prost(message, tag = "3")]
        DisplayName(OpcUaDisplayName),
        #[prost(message, tag = "4")]
        FullPath(OpcUaFullPath),
    }
}
#[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>,
}
#[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 {
    #[prost(message, repeated, tag = "1")]
    pub root_nodes: ::prost::alloc::vec::Vec<OpcNode>,
    #[prost(message, repeated, tag = "2")]
    pub skip_nodes: ::prost::alloc::vec::Vec<OpcNode>,
    #[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 {
    #[derive(Clone, Copy, PartialEq, ::prost::Message)]
    pub struct OpcUaServerTime {}
    #[derive(Clone, Copy, PartialEq, ::prost::Message)]
    pub struct OpcUaSourceTime {}
    #[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 {
    #[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,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OpcUaScrapingConfig {
    #[prost(message, optional, tag = "1")]
    pub node_exploration_config: ::core::option::Option<OpcUaNodeExplorationConfig>,
    #[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>,
    #[prost(bool, tag = "4")]
    pub override_host: bool,
    #[prost(enumeration = "OpcUaUnknownDataTypeHandling", tag = "5")]
    pub unknown_data_type_handling: i32,
    #[prost(enumeration = "OpcUaFailedMonitorHandling", tag = "6")]
    pub failed_monitor_handling: i32,
    #[prost(message, optional, tag = "7")]
    pub timestamp_handling: ::core::option::Option<OpcUaTimestampHandling>,
    #[prost(message, optional, tag = "8")]
    pub data_change_filter: ::core::option::Option<OpcUaDataChangeFilter>,
}
#[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,
    Error = 1,
    TreatAsDouble = 2,
    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,
        }
    }
}