Skip to main content

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

1/// The array is flattened out into a an arrow stream of bucketed primitive results, with an extra column to
2/// indicate the index of the array that the bucket corresponds to.
3#[derive(
4    Debug,
5    Clone,
6    conjure_object::serde::Serialize,
7    conjure_object::serde::Deserialize,
8    PartialEq,
9    Eq,
10    PartialOrd,
11    Ord,
12    Hash
13)]
14#[serde(crate = "conjure_object::serde")]
15#[conjure_object::private::staged_builder::staged_builder]
16#[builder(crate = conjure_object::private::staged_builder, update, inline)]
17pub struct BucketedEnumArrayPlot {
18    #[builder(into)]
19    #[serde(rename = "arrowBinary")]
20    arrow_binary: conjure_object::Bytes,
21    #[builder(default, into)]
22    #[serde(rename = "groupByKeys", skip_serializing_if = "Option::is_none", default)]
23    group_by_keys: Option<Vec<String>>,
24}
25impl BucketedEnumArrayPlot {
26    /// Constructs a new instance of the type.
27    #[inline]
28    pub fn new(arrow_binary: impl Into<conjure_object::Bytes>) -> Self {
29        Self::builder().arrow_binary(arrow_binary).build()
30    }
31    /// The raw binary containing Arrow IPC stream for a bucketed N-dimensional enum array plot.
32    #[inline]
33    pub fn arrow_binary(&self) -> &conjure_object::Bytes {
34        &self.arrow_binary
35    }
36    /// This field specifies the tags that the final output is grouped by. When you combine multiple channels,
37    /// this list represents the superset of all group by keys used across every individual channel.
38    #[inline]
39    pub fn group_by_keys(&self) -> Option<&[String]> {
40        self.group_by_keys.as_ref().map(|o| &**o)
41    }
42}