nominal-api 0.1240.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

#[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 SeriesMetadata {
    #[serde(rename = "rid")]
    rid: super::super::super::super::api::SeriesMetadataRid,
    #[serde(rename = "channel")]
    channel: super::super::super::super::api::Channel,
    #[serde(rename = "dataSourceRid")]
    data_source_rid: super::super::super::super::api::rids::DataSourceRid,
    #[builder(custom(type = super::LocatorTemplate, convert = Box::new))]
    #[serde(rename = "locator")]
    locator: Box<super::LocatorTemplate>,
    #[builder(default, into)]
    #[serde(rename = "unit", skip_serializing_if = "Option::is_none", default)]
    unit: Option<super::super::super::super::api::Unit>,
    #[builder(default, into)]
    #[serde(rename = "description", skip_serializing_if = "Option::is_none", default)]
    description: Option<String>,
    #[builder(
        default,
        map(
            key(type = super::super::super::super::api::TagName),
            value(type = super::super::super::super::api::TagValue)
        )
    )]
    #[serde(
        rename = "tags",
        skip_serializing_if = "std::collections::BTreeMap::is_empty",
        default
    )]
    tags: std::collections::BTreeMap<
        super::super::super::super::api::TagName,
        super::super::super::super::api::TagValue,
    >,
    #[builder(default, into)]
    #[serde(rename = "seriesDataType", skip_serializing_if = "Option::is_none", default)]
    series_data_type: Option<super::super::super::super::api::SeriesDataType>,
}
impl SeriesMetadata {
    #[inline]
    pub fn rid(&self) -> &super::super::super::super::api::SeriesMetadataRid {
        &self.rid
    }
    #[inline]
    pub fn channel(&self) -> &super::super::super::super::api::Channel {
        &self.channel
    }
    #[inline]
    pub fn data_source_rid(
        &self,
    ) -> &super::super::super::super::api::rids::DataSourceRid {
        &self.data_source_rid
    }
    #[inline]
    pub fn locator(&self) -> &super::LocatorTemplate {
        &*self.locator
    }
    #[inline]
    pub fn unit(&self) -> Option<&super::super::super::super::api::Unit> {
        self.unit.as_ref().map(|o| &*o)
    }
    #[inline]
    pub fn description(&self) -> Option<&str> {
        self.description.as_ref().map(|o| &**o)
    }
    /// Tags specified here will take precedence over tags specified in the RunDatasource, in the case that both specify the same TagName.
    #[deprecated(note = "Deprecated. Should not be used.")]
    #[inline]
    pub fn tags(
        &self,
    ) -> &std::collections::BTreeMap<
        super::super::super::super::api::TagName,
        super::super::super::super::api::TagValue,
    > {
        &self.tags
    }
    #[inline]
    pub fn series_data_type(
        &self,
    ) -> Option<&super::super::super::super::api::SeriesDataType> {
        self.series_data_type.as_ref().map(|o| &*o)
    }
}