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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

#[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 DataSourceChannel {
    #[builder(custom(type = super::StringConstant, convert = Box::new))]
    #[serde(rename = "dataSourceRid")]
    data_source_rid: Box<super::StringConstant>,
    #[builder(custom(type = super::StringConstant, convert = Box::new))]
    #[serde(rename = "channel")]
    channel: Box<super::StringConstant>,
    #[builder(
        default,
        map(key(type = String, into), value(type = super::StringConstant))
    )]
    #[serde(
        rename = "tags",
        skip_serializing_if = "std::collections::BTreeMap::is_empty",
        default
    )]
    tags: std::collections::BTreeMap<String, super::StringConstant>,
    #[builder(
        default,
        custom(
            type = impl
            Into<Option<super::TagFilters>>,
            convert = |v|v.into().map(Box::new)
        )
    )]
    #[serde(rename = "tagFilters", skip_serializing_if = "Option::is_none", default)]
    tag_filters: Option<Box<super::TagFilters>>,
    #[builder(default, set(item(type = String, into)))]
    #[serde(
        rename = "tagsToGroupBy",
        skip_serializing_if = "std::collections::BTreeSet::is_empty",
        default
    )]
    tags_to_group_by: std::collections::BTreeSet<String>,
    #[builder(default, set(item(type = super::StringConstant)))]
    #[serde(
        rename = "groupByTags",
        skip_serializing_if = "std::collections::BTreeSet::is_empty",
        default
    )]
    group_by_tags: std::collections::BTreeSet<super::StringConstant>,
}
impl DataSourceChannel {
    /// Constructs a new instance of the type.
    #[inline]
    pub fn new(
        data_source_rid: super::StringConstant,
        channel: super::StringConstant,
    ) -> Self {
        Self::builder().data_source_rid(data_source_rid).channel(channel).build()
    }
    #[inline]
    pub fn data_source_rid(&self) -> &super::StringConstant {
        &*self.data_source_rid
    }
    #[inline]
    pub fn channel(&self) -> &super::StringConstant {
        &*self.channel
    }
    #[deprecated(note = "Use tagFilters")]
    #[inline]
    pub fn tags(&self) -> &std::collections::BTreeMap<String, super::StringConstant> {
        &self.tags
    }
    /// Tags to filter the channel by. Only returns points from the channel where tag values match the provided
    /// expression. For log series, include arg filters here in addition to tag filters.
    #[inline]
    pub fn tag_filters(&self) -> Option<&super::TagFilters> {
        self.tag_filters.as_ref().map(|o| &**o)
    }
    #[deprecated(
        note = "Use groupByTags instead. Throws if both tagsToGroupBy and groupByTags are specified.\n"
    )]
    #[inline]
    pub fn tags_to_group_by(&self) -> &std::collections::BTreeSet<String> {
        &self.tags_to_group_by
    }
    /// Tags that the channel should be grouped by. If this is non-empty a grouped result will be returned
    /// with an entry for each grouping. Only one of tagsToGroupBy and groupByTags should be specified.
    #[inline]
    pub fn group_by_tags(&self) -> &std::collections::BTreeSet<super::StringConstant> {
        &self.group_by_tags
    }
}