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

#[derive(
    Debug,
    Clone,
    conjure_object::serde::Serialize,
    conjure_object::serde::Deserialize,
    PartialEq,
    Eq,
    PartialOrd,
    Ord,
    Hash
)]
#[serde(crate = "conjure_object::serde")]
#[conjure_object::private::staged_builder::staged_builder]
#[builder(crate = conjure_object::private::staged_builder, update, inline)]
pub struct ChannelMetadata {
    #[serde(rename = "name")]
    name: super::super::super::api::Channel,
    #[serde(rename = "dataSource")]
    data_source: super::super::super::api::rids::DataSourceRid,
    #[builder(
        default,
        custom(
            type = impl
            Into<Option<super::super::super::scout::run::api::Unit>>,
            convert = |v|v.into().map(Box::new)
        )
    )]
    #[serde(rename = "unit", skip_serializing_if = "Option::is_none", default)]
    unit: Option<Box<super::super::super::scout::run::api::Unit>>,
    #[builder(default, into)]
    #[serde(rename = "description", skip_serializing_if = "Option::is_none", default)]
    description: Option<String>,
    #[builder(default, into)]
    #[serde(rename = "dataType", skip_serializing_if = "Option::is_none", default)]
    data_type: Option<super::super::super::api::SeriesDataType>,
    #[builder(
        custom(type = super::SeriesMetadataRidOrLogicalSeriesRid, convert = Box::new)
    )]
    #[serde(rename = "seriesRid")]
    series_rid: Box<super::SeriesMetadataRidOrLogicalSeriesRid>,
}
impl ChannelMetadata {
    /// Constructs a new instance of the type.
    #[inline]
    pub fn new(
        name: super::super::super::api::Channel,
        data_source: super::super::super::api::rids::DataSourceRid,
        series_rid: super::SeriesMetadataRidOrLogicalSeriesRid,
    ) -> Self {
        Self::builder()
            .name(name)
            .data_source(data_source)
            .series_rid(series_rid)
            .build()
    }
    #[inline]
    pub fn name(&self) -> &super::super::super::api::Channel {
        &self.name
    }
    #[inline]
    pub fn data_source(&self) -> &super::super::super::api::rids::DataSourceRid {
        &self.data_source
    }
    #[inline]
    pub fn unit(&self) -> Option<&super::super::super::scout::run::api::Unit> {
        self.unit.as_ref().map(|o| &**o)
    }
    #[inline]
    pub fn description(&self) -> Option<&str> {
        self.description.as_ref().map(|o| &**o)
    }
    #[inline]
    pub fn data_type(&self) -> Option<&super::super::super::api::SeriesDataType> {
        self.data_type.as_ref().map(|o| &*o)
    }
    #[inline]
    pub fn series_rid(&self) -> &super::SeriesMetadataRidOrLogicalSeriesRid {
        &*self.series_rid
    }
}