nominal_api/conjure/objects/scout/asset/api/
data_scope.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 DataScope {
16    #[serde(rename = "dataScopeName")]
17    data_scope_name: super::super::super::api::DataSourceRefName,
18    #[builder(
19        custom(type = super::super::super::run::api::DataSource, convert = Box::new)
20    )]
21    #[serde(rename = "dataSource")]
22    data_source: Box<super::super::super::run::api::DataSource>,
23    #[builder(
24        default,
25        custom(
26            type = impl
27            Into<Option<super::super::super::run::api::Duration>>,
28            convert = |v|v.into().map(Box::new)
29        )
30    )]
31    #[serde(rename = "offset", skip_serializing_if = "Option::is_none", default)]
32    offset: Option<Box<super::super::super::run::api::Duration>>,
33    #[serde(rename = "timestampType")]
34    timestamp_type: super::super::super::run::api::WeakTimestampType,
35    #[builder(
36        default,
37        map(
38            key(type = super::super::super::super::api::TagName),
39            value(type = super::super::super::super::api::TagValue)
40        )
41    )]
42    #[serde(
43        rename = "seriesTags",
44        skip_serializing_if = "std::collections::BTreeMap::is_empty",
45        default
46    )]
47    series_tags: std::collections::BTreeMap<
48        super::super::super::super::api::TagName,
49        super::super::super::super::api::TagValue,
50    >,
51}
52impl DataScope {
53    /// Constructs a new instance of the type.
54    #[inline]
55    pub fn new(
56        data_scope_name: super::super::super::api::DataSourceRefName,
57        data_source: super::super::super::run::api::DataSource,
58        timestamp_type: super::super::super::run::api::WeakTimestampType,
59    ) -> Self {
60        Self::builder()
61            .data_scope_name(data_scope_name)
62            .data_source(data_source)
63            .timestamp_type(timestamp_type)
64            .build()
65    }
66    /// The name of the data scope. The name is guaranteed to be be unique within the context of an asset.
67    #[inline]
68    pub fn data_scope_name(&self) -> &super::super::super::api::DataSourceRefName {
69        &self.data_scope_name
70    }
71    #[inline]
72    pub fn data_source(&self) -> &super::super::super::run::api::DataSource {
73        &*self.data_source
74    }
75    #[inline]
76    pub fn offset(&self) -> Option<&super::super::super::run::api::Duration> {
77        self.offset.as_ref().map(|o| &**o)
78    }
79    #[inline]
80    pub fn timestamp_type(&self) -> &super::super::super::run::api::WeakTimestampType {
81        &self.timestamp_type
82    }
83    /// Filters the data source to series matching these tag values. The filtered set of series should be
84    /// the ones that belong to the asset.
85    #[inline]
86    pub fn series_tags(
87        &self,
88    ) -> &std::collections::BTreeMap<
89        super::super::super::super::api::TagName,
90        super::super::super::super::api::TagValue,
91    > {
92        &self.series_tags
93    }
94}
nominal_api/conjure/objects/scout/asset/api/data_scope.rs

nominal_api/conjure/objects/scout/asset/api/
data_scope.rs
