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

/// Aggregates the input series under the ranges in the provided ranges series, and outputs a new series with one
/// point at the start of each range, where the value is the aggregation result. If a range has no points, no
/// point will be produced for it. If a range has no start, the point produced for it will be at the
/// start of the compute request range.
#[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 AggregateUnderRangesSeries {
    #[builder(custom(type = super::NumericSeries, convert = Box::new))]
    #[serde(rename = "input")]
    input: Box<super::NumericSeries>,
    #[builder(custom(type = super::RangeSeries, convert = Box::new))]
    #[serde(rename = "ranges")]
    ranges: Box<super::RangeSeries>,
    #[serde(rename = "operation")]
    operation: super::NumericAggregationFunction,
}
impl AggregateUnderRangesSeries {
    /// Constructs a new instance of the type.
    #[inline]
    pub fn new(
        input: super::NumericSeries,
        ranges: super::RangeSeries,
        operation: super::NumericAggregationFunction,
    ) -> Self {
        Self::builder().input(input).ranges(ranges).operation(operation).build()
    }
    #[inline]
    pub fn input(&self) -> &super::NumericSeries {
        &*self.input
    }
    #[inline]
    pub fn ranges(&self) -> &super::RangeSeries {
        &*self.ranges
    }
    #[deprecated(
        note = "Use a dedicated group-by-and-aggregate node instead (coming in a follow-up PR). This field is retained\nas required for backwards compatibility with existing callers.\n"
    )]
    #[inline]
    pub fn operation(&self) -> &super::NumericAggregationFunction {
        &self.operation
    }
}