nominal-api-conjure 0.1330.0

Conjure HTTP 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

/// A series selected from a dataset, bound to a variable. The series type (numeric, enum, ...) is decided
/// lazily by the node consuming the variable, matching the behaviour of channel variables.
#[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 SeriesVariable {
    #[builder(custom(type = super::SelectSeries, convert = Box::new))]
    #[serde(rename = "select")]
    select: Box<super::SelectSeries>,
    #[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 SeriesVariable {
    /// Constructs a new instance of the type.
    #[inline]
    pub fn new(select: super::SelectSeries) -> Self {
        Self::builder().select(select).build()
    }
    #[inline]
    pub fn select(&self) -> &super::SelectSeries {
        &*self.select
    }
    /// Tags that the series should be grouped by. If this is non-empty a grouped result will be returned
    /// with an entry for each grouping; otherwise all matching series are merged.
    #[inline]
    pub fn group_by_tags(&self) -> &std::collections::BTreeSet<super::StringConstant> {
        &self.group_by_tags
    }
}