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

/// The array is flattened out into a an arrow stream of bucketed primitive results, with an extra column to
/// indicate the index of the array that the bucket corresponds to.
#[derive(
    Debug,
    Clone,
    conjure_object::serde::Serialize,
    conjure_object::serde::Deserialize,
    PartialEq,
    Eq,
    PartialOrd,
    Ord,
    Hash
)]
#[serde(crate = "conjure_object::serde")]
#[conjure_object::private::staged_builder::staged_builder]
#[builder(crate = conjure_object::private::staged_builder, update, inline)]
pub struct BucketedNumericArrayPlot {
    #[builder(into)]
    #[serde(rename = "arrowBinary")]
    arrow_binary: conjure_object::Bytes,
    #[builder(default, into)]
    #[serde(rename = "groupByKeys", skip_serializing_if = "Option::is_none", default)]
    group_by_keys: Option<Vec<String>>,
}
impl BucketedNumericArrayPlot {
    /// Constructs a new instance of the type.
    #[inline]
    pub fn new(arrow_binary: impl Into<conjure_object::Bytes>) -> Self {
        Self::builder().arrow_binary(arrow_binary).build()
    }
    /// The raw binary containing Arrow IPC stream for a bucketed N-dimensional numeric array plot.
    #[inline]
    pub fn arrow_binary(&self) -> &conjure_object::Bytes {
        &self.arrow_binary
    }
    /// This field specifies the tags that the final output is grouped by. When you combine multiple channels,
    /// this list represents the superset of all group by keys used across every individual channel.
    #[inline]
    pub fn group_by_keys(&self) -> Option<&[String]> {
        self.group_by_keys.as_ref().map(|o| &**o)
    }
}