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

#[derive(
    Debug,
    Clone,
    conjure_object::serde::Serialize,
    conjure_object::serde::Deserialize,
    conjure_object::private::DeriveWith
)]
#[serde(crate = "conjure_object::serde")]
#[derive_with(PartialEq, Eq, PartialOrd, Ord, Hash)]
#[conjure_object::private::staged_builder::staged_builder]
#[builder(crate = conjure_object::private::staged_builder, update, inline)]
pub struct GetSeriesCountRequest {
    #[serde(rename = "dataSourceRid")]
    data_source_rid: super::super::super::api::rids::DataSourceRid,
    #[serde(rename = "channel")]
    channel: super::super::super::api::Channel,
    #[builder(custom(type = super::super::super::api::Range, convert = Box::new))]
    #[serde(rename = "range")]
    range: Box<super::super::super::api::Range>,
    #[builder(
        default,
        custom(
            type = impl
            Into<Option<super::super::super::scout::compute::api::TagFilters>>,
            convert = |v|v.into().map(Box::new)
        )
    )]
    #[serde(rename = "tagFilters", skip_serializing_if = "Option::is_none", default)]
    tag_filters: Option<Box<super::super::super::scout::compute::api::TagFilters>>,
    #[builder(
        default,
        custom(
            type = impl
            Into<Option<super::super::super::scout::compute::api::Context>>,
            convert = |v|v.into().map(Box::new)
        )
    )]
    #[serde(rename = "context", skip_serializing_if = "Option::is_none", default)]
    context: Option<Box<super::super::super::scout::compute::api::Context>>,
}
impl GetSeriesCountRequest {
    /// Constructs a new instance of the type.
    #[inline]
    pub fn new(
        data_source_rid: super::super::super::api::rids::DataSourceRid,
        channel: super::super::super::api::Channel,
        range: super::super::super::api::Range,
    ) -> Self {
        Self::builder()
            .data_source_rid(data_source_rid)
            .channel(channel)
            .range(range)
            .build()
    }
    #[inline]
    pub fn data_source_rid(&self) -> &super::super::super::api::rids::DataSourceRid {
        &self.data_source_rid
    }
    #[inline]
    pub fn channel(&self) -> &super::super::super::api::Channel {
        &self.channel
    }
    #[inline]
    pub fn range(&self) -> &super::super::super::api::Range {
        &*self.range
    }
    /// Tag filters to apply when counting series. Supports IN/NOT_IN operators and AND composition,
    /// matching the tag filter semantics used in compute queries.
    #[inline]
    pub fn tag_filters(
        &self,
    ) -> Option<&super::super::super::scout::compute::api::TagFilters> {
        self.tag_filters.as_ref().map(|o| &**o)
    }
    /// Variable context for resolving variables in tag filters. Same context format used in compute APIs.
    #[inline]
    pub fn context(&self) -> Option<&super::super::super::scout::compute::api::Context> {
        self.context.as_ref().map(|o| &**o)
    }
}