nominal-api 0.1239.0

API bindings for the Nominal platform
Documentation
/// A generic Arrow IPC plot response. Used for all Arrow-serialized plot types (numeric, bucketed numeric,
/// enum, bucketed enum, struct, bucketed struct, full resolution, and bucketed multivariate).
#[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 ArrowPlot {
    #[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>>,
    #[builder(
        default,
        custom(
            type = impl
            Into<Option<super::PageToken>>,
            convert = |v|v.into().map(Box::new)
        )
    )]
    #[serde(rename = "nextPageToken", skip_serializing_if = "Option::is_none", default)]
    next_page_token: Option<Box<super::PageToken>>,
}
impl ArrowPlot {
    /// 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 an Arrow IPC stream.
    #[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)
    }
    /// Continuation token for this paged result. Can only be returned if paging was requested.
    /// To retrieve the next page, repeat the same request with this
    /// value as `pageToken` and keep the pageSize sign unchanged. Returned only when this response
    /// contains exactly `abs(pageSize)` points; the next response may still be empty if this page ended exactly at
    /// the result-set boundary. Empty means this response was short and there are no further points in the
    /// requested direction.
    #[inline]
    pub fn next_page_token(&self) -> Option<&super::PageToken> {
        self.next_page_token.as_ref().map(|o| &**o)
    }
}