nominal_api/conjure/objects/timeseries/metadata/api/
create_series_metadata_request.rs

1#[derive(
2    Debug,
3    Clone,
4    conjure_object::serde::Serialize,
5    conjure_object::serde::Deserialize,
6    PartialEq,
7    Eq,
8    PartialOrd,
9    Ord,
10    Hash
11)]
12#[serde(crate = "conjure_object::serde")]
13#[conjure_object::private::staged_builder::staged_builder]
14#[builder(crate = conjure_object::private::staged_builder, update, inline)]
15pub struct CreateSeriesMetadataRequest {
16    #[serde(rename = "channel")]
17    channel: super::super::super::super::api::Channel,
18    #[serde(rename = "dataSourceRid")]
19    data_source_rid: super::super::super::super::api::rids::DataSourceRid,
20    #[builder(custom(type = super::LocatorTemplate, convert = Box::new))]
21    #[serde(rename = "locator")]
22    locator: Box<super::LocatorTemplate>,
23    #[builder(default, into)]
24    #[serde(rename = "unit", skip_serializing_if = "Option::is_none", default)]
25    unit: Option<super::super::super::super::api::Unit>,
26    #[builder(default, into)]
27    #[serde(rename = "description", skip_serializing_if = "Option::is_none", default)]
28    description: Option<String>,
29    #[builder(
30        default,
31        map(
32            key(type = super::super::super::super::api::TagName),
33            value(type = super::super::super::super::api::TagValue)
34        )
35    )]
36    #[serde(
37        rename = "tags",
38        skip_serializing_if = "std::collections::BTreeMap::is_empty",
39        default
40    )]
41    tags: std::collections::BTreeMap<
42        super::super::super::super::api::TagName,
43        super::super::super::super::api::TagValue,
44    >,
45}
46impl CreateSeriesMetadataRequest {
47    /// Constructs a new instance of the type.
48    #[inline]
49    pub fn new(
50        channel: super::super::super::super::api::Channel,
51        data_source_rid: super::super::super::super::api::rids::DataSourceRid,
52        locator: super::LocatorTemplate,
53    ) -> Self {
54        Self::builder()
55            .channel(channel)
56            .data_source_rid(data_source_rid)
57            .locator(locator)
58            .build()
59    }
60    /// This name should be unique amongst SeriesMetadata within the data source. All series created from this
61    /// metadata will share this name.
62    #[inline]
63    pub fn channel(&self) -> &super::super::super::super::api::Channel {
64        &self.channel
65    }
66    #[inline]
67    pub fn data_source_rid(
68        &self,
69    ) -> &super::super::super::super::api::rids::DataSourceRid {
70        &self.data_source_rid
71    }
72    #[inline]
73    pub fn locator(&self) -> &super::LocatorTemplate {
74        &*self.locator
75    }
76    #[inline]
77    pub fn unit(&self) -> Option<&super::super::super::super::api::Unit> {
78        self.unit.as_ref().map(|o| &*o)
79    }
80    #[inline]
81    pub fn description(&self) -> Option<&str> {
82        self.description.as_ref().map(|o| &**o)
83    }
84    /// Tags specified here will take precedence over tags specified in the RunDatasource, in the case that both specify the same TagName.
85    #[deprecated(note = "Deprecated. Should not be used.")]
86    #[inline]
87    pub fn tags(
88        &self,
89    ) -> &std::collections::BTreeMap<
90        super::super::super::super::api::TagName,
91        super::super::super::super::api::TagValue,
92    > {
93        &self.tags
94    }
95}
nominal_api/conjure/objects/timeseries/metadata/api/create_series_metadata_request.rs

nominal_api/conjure/objects/timeseries/metadata/api/
create_series_metadata_request.rs
