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
99
100
101
102
103
104
105
106
107
108

/// Summarizes the output of a series node. The output can be a numeric, enum, log, or cartesian series.
/// Summarization strategy should be specified.
#[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 SummarizeSeries {
    #[builder(custom(type = super::Series, convert = Box::new))]
    #[serde(rename = "input")]
    input: Box<super::Series>,
    #[builder(default, into)]
    #[serde(rename = "outputFormat", skip_serializing_if = "Option::is_none", default)]
    output_format: Option<super::OutputFormat>,
    #[builder(default, into)]
    #[serde(
        rename = "numericOutputFields",
        skip_serializing_if = "Option::is_none",
        default
    )]
    numeric_output_fields: Option<std::collections::BTreeSet<super::NumericOutputField>>,
    #[builder(
        default,
        map(key(type = String, into), value(type = super::NumericAggregationOperator))
    )]
    #[serde(
        rename = "numericAggregations",
        skip_serializing_if = "std::collections::BTreeMap::is_empty",
        default
    )]
    numeric_aggregations: std::collections::BTreeMap<
        String,
        super::NumericAggregationOperator,
    >,
    #[builder(default, into)]
    #[serde(rename = "resolution", skip_serializing_if = "Option::is_none", default)]
    resolution: Option<conjure_object::SafeLong>,
    #[builder(default, into)]
    #[serde(rename = "buckets", skip_serializing_if = "Option::is_none", default)]
    buckets: Option<i32>,
    #[builder(
        default,
        custom(
            type = impl
            Into<Option<super::SummarizationStrategy>>,
            convert = |v|v.into().map(Box::new)
        )
    )]
    #[serde(
        rename = "summarizationStrategy",
        skip_serializing_if = "Option::is_none",
        default
    )]
    summarization_strategy: Option<Box<super::SummarizationStrategy>>,
}
impl SummarizeSeries {
    /// Constructs a new instance of the type.
    #[inline]
    pub fn new(input: super::Series) -> Self {
        Self::builder().input(input).build()
    }
    #[inline]
    pub fn input(&self) -> &super::Series {
        &*self.input
    }
    /// The output format of the response. Defaults to LEGACY.
    #[inline]
    pub fn output_format(&self) -> Option<&super::OutputFormat> {
        self.output_format.as_ref().map(|o| &*o)
    }
    /// The fields to output from the summarization. Applies only to Arrow format numeric series.
    #[inline]
    pub fn numeric_output_fields(
        &self,
    ) -> Option<&std::collections::BTreeSet<super::NumericOutputField>> {
        self.numeric_output_fields.as_ref().map(|o| &*o)
    }
    /// Additional numeric aggregations per decimation bucket (e.g. percentiles). Map key is the name of the column in the result.
    #[inline]
    pub fn numeric_aggregations(
        &self,
    ) -> &std::collections::BTreeMap<String, super::NumericAggregationOperator> {
        &self.numeric_aggregations
    }
    /// Resolution of the output series specifying time interval between decimated points, in nanoseconds.
    #[deprecated(note = "Use summarizationStrategy instead.\n")]
    #[inline]
    pub fn resolution(&self) -> Option<conjure_object::SafeLong> {
        self.resolution.as_ref().map(|o| *o)
    }
    /// Number of points to generate in the output series.
    #[deprecated(note = "Use summarizationStrategy instead.\n")]
    #[inline]
    pub fn buckets(&self) -> Option<i32> {
        self.buckets.as_ref().map(|o| *o)
    }
    /// The strategy to use when summarizing the series.
    #[inline]
    pub fn summarization_strategy(&self) -> Option<&super::SummarizationStrategy> {
        self.summarization_strategy.as_ref().map(|o| &**o)
    }
}