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
81
82
83

#[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 CreateAssetDataScope {
    #[serde(rename = "dataScopeName")]
    data_scope_name: super::super::super::api::DataSourceRefName,
    #[builder(
        custom(type = super::super::super::run::api::DataSource, convert = Box::new)
    )]
    #[serde(rename = "dataSource")]
    data_source: Box<super::super::super::run::api::DataSource>,
    #[builder(
        default,
        custom(
            type = impl
            Into<Option<super::super::super::run::api::Duration>>,
            convert = |v|v.into().map(Box::new)
        )
    )]
    #[serde(rename = "offset", skip_serializing_if = "Option::is_none", default)]
    offset: Option<Box<super::super::super::run::api::Duration>>,
    #[builder(
        default,
        map(
            key(type = super::super::super::super::api::TagName),
            value(type = super::super::super::super::api::TagValue)
        )
    )]
    #[serde(
        rename = "seriesTags",
        skip_serializing_if = "std::collections::BTreeMap::is_empty",
        default
    )]
    series_tags: std::collections::BTreeMap<
        super::super::super::super::api::TagName,
        super::super::super::super::api::TagValue,
    >,
}
impl CreateAssetDataScope {
    /// Constructs a new instance of the type.
    #[inline]
    pub fn new(
        data_scope_name: super::super::super::api::DataSourceRefName,
        data_source: super::super::super::run::api::DataSource,
    ) -> Self {
        Self::builder().data_scope_name(data_scope_name).data_source(data_source).build()
    }
    /// The name of the data scope. The name is guaranteed to be be unique within the context of an asset.
    #[inline]
    pub fn data_scope_name(&self) -> &super::super::super::api::DataSourceRefName {
        &self.data_scope_name
    }
    #[inline]
    pub fn data_source(&self) -> &super::super::super::run::api::DataSource {
        &*self.data_source
    }
    #[inline]
    pub fn offset(&self) -> Option<&super::super::super::run::api::Duration> {
        self.offset.as_ref().map(|o| &**o)
    }
    /// Filters the data source to series matching these tag values. The filtered set of series should be
    /// the ones that belong to the asset.
    #[inline]
    pub fn series_tags(
        &self,
    ) -> &std::collections::BTreeMap<
        super::super::super::super::api::TagName,
        super::super::super::super::api::TagValue,
    > {
        &self.series_tags
    }
}