Skip to main content

nominal_api_conjure/conjure/objects/scout/compute/api/
with_series_dataset.rs

1/// Adds one or more derived series to the base dataset. Each entry's definition must reference only the
2/// wrapping `input`. Series names must be unique within the request; a derived name replaces a same-named
3/// series from `input`.
4#[derive(
5    Debug,
6    Clone,
7    conjure_object::serde::Serialize,
8    conjure_object::serde::Deserialize,
9    conjure_object::private::DeriveWith
10)]
11#[serde(crate = "conjure_object::serde")]
12#[derive_with(PartialEq, Eq, PartialOrd, Ord, Hash)]
13#[conjure_object::private::staged_builder::staged_builder]
14#[builder(crate = conjure_object::private::staged_builder, update, inline)]
15pub struct WithSeriesDataset {
16    #[builder(custom(type = super::Dataset, convert = Box::new))]
17    #[serde(rename = "input")]
18    input: Box<super::Dataset>,
19    #[builder(default, list(item(type = super::NamedSeries)))]
20    #[serde(rename = "series", skip_serializing_if = "Vec::is_empty", default)]
21    series: Vec<super::NamedSeries>,
22}
23impl WithSeriesDataset {
24    /// Constructs a new instance of the type.
25    #[inline]
26    pub fn new(input: super::Dataset) -> Self {
27        Self::builder().input(input).build()
28    }
29    /// The base dataset to which the new series will be added.
30    #[inline]
31    pub fn input(&self) -> &super::Dataset {
32        &*self.input
33    }
34    /// The named derived series to add.
35    #[inline]
36    pub fn series(&self) -> &[super::NamedSeries] {
37        &*self.series
38    }
39}