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

/// A bucket in a numeric histogram representing a range of values,
/// and the counts of values in that range across all input series.
#[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 NumericHistogramBucket {
    #[serde(rename = "lowerBound")]
    #[derive_with(with = conjure_object::private::DoubleWrapper)]
    lower_bound: f64,
    #[serde(rename = "upperBound")]
    #[derive_with(with = conjure_object::private::DoubleWrapper)]
    upper_bound: f64,
    #[builder(
        default,
        map(key(type = super::VariableName), value(type = super::HistogramChannelCount))
    )]
    #[serde(
        rename = "countsByChannel",
        skip_serializing_if = "std::collections::BTreeMap::is_empty",
        default
    )]
    counts_by_channel: std::collections::BTreeMap<
        super::VariableName,
        super::HistogramChannelCount,
    >,
    #[builder(
        default,
        map(key(type = super::VariableName), value(type = super::HistogramChannelCount))
    )]
    #[serde(
        rename = "buckets",
        skip_serializing_if = "std::collections::BTreeMap::is_empty",
        default
    )]
    buckets: std::collections::BTreeMap<
        super::VariableName,
        super::HistogramChannelCount,
    >,
}
impl NumericHistogramBucket {
    /// Constructs a new instance of the type.
    #[inline]
    pub fn new(lower_bound: f64, upper_bound: f64) -> Self {
        Self::builder().lower_bound(lower_bound).upper_bound(upper_bound).build()
    }
    /// The lower bound of the bucket, inclusive
    #[inline]
    pub fn lower_bound(&self) -> f64 {
        self.lower_bound
    }
    /// The upper bound of the bucket, exclusive
    #[inline]
    pub fn upper_bound(&self) -> f64 {
        self.upper_bound
    }
    #[inline]
    pub fn counts_by_channel(
        &self,
    ) -> &std::collections::BTreeMap<super::VariableName, super::HistogramChannelCount> {
        &self.counts_by_channel
    }
    #[deprecated(note = "Use countsByChannel instead")]
    #[inline]
    pub fn buckets(
        &self,
    ) -> &std::collections::BTreeMap<super::VariableName, super::HistogramChannelCount> {
        &self.buckets
    }
}