Skip to main content

nominal_api/conjure/objects/scout/compute/api/
select_series.rs

1/// Selects a specific series from a data frame (might contain multiple tag groupings).
2#[derive(
3    Debug,
4    Clone,
5    conjure_object::serde::Serialize,
6    conjure_object::serde::Deserialize,
7    conjure_object::private::DeriveWith
8)]
9#[serde(crate = "conjure_object::serde")]
10#[derive_with(PartialEq, Eq, PartialOrd, Ord, Hash)]
11#[conjure_object::private::staged_builder::staged_builder]
12#[builder(crate = conjure_object::private::staged_builder, update, inline)]
13pub struct SelectSeries {
14    #[builder(custom(type = super::DataFrame, convert = Box::new))]
15    #[serde(rename = "dataFrame")]
16    data_frame: Box<super::DataFrame>,
17    #[builder(custom(type = super::StringConstant, convert = Box::new))]
18    #[serde(rename = "name")]
19    name: Box<super::StringConstant>,
20}
21impl SelectSeries {
22    /// Constructs a new instance of the type.
23    #[inline]
24    pub fn new(data_frame: super::DataFrame, name: super::StringConstant) -> Self {
25        Self::builder().data_frame(data_frame).name(name).build()
26    }
27    /// The data frame providing the data to query
28    #[inline]
29    pub fn data_frame(&self) -> &super::DataFrame {
30        &*self.data_frame
31    }
32    /// The identifying series name to query
33    #[inline]
34    pub fn name(&self) -> &super::StringConstant {
35        &*self.name
36    }
37}