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(default, map(key(type = String, into), value(type = String, into)))]
36    #[serde(
37        rename = "seriesTags",
38        skip_serializing_if = "std::collections::BTreeMap::is_empty",
39        default
40    )]
41    series_tags: std::collections::BTreeMap<String, String>,
42}
43impl DataScope {
44    /// Constructs a new instance of the type.
45    #[inline]
46    pub fn new(
47        data_scope_name: super::super::super::api::DataSourceRefName,
48        data_source: super::super::super::run::api::DataSource,
49        timestamp_type: super::super::super::run::api::WeakTimestampType,
50    ) -> Self {
51        Self::builder()
52            .data_scope_name(data_scope_name)
53            .data_source(data_source)
54            .timestamp_type(timestamp_type)
55            .build()
56    }
57    /// The name of the data scope. The name is guaranteed to be be unique within the context of an asset.
58    #[inline]
59    pub fn data_scope_name(&self) -> &super::super::super::api::DataSourceRefName {
60        &self.data_scope_name
61    }
62    #[inline]
63    pub fn data_source(&self) -> &super::super::super::run::api::DataSource {
64        &*self.data_source
65    }
66    #[inline]
67    pub fn offset(&self) -> Option<&super::super::super::run::api::Duration> {
68        self.offset.as_ref().map(|o| &**o)
69    }
70    #[inline]
71    pub fn timestamp_type(&self) -> &super::super::super::run::api::WeakTimestampType {
72        &self.timestamp_type
73    }
74    /// Filters the data source to series matching these tag values. The filtered set of series should be
75    /// the ones that belong to the asset.
76    #[inline]
77    pub fn series_tags(&self) -> &std::collections::BTreeMap<String, String> {
78        &self.series_tags
79    }
80}
nominal_api/conjure/objects/scout/asset/api/data_scope.rs

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