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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

#[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 IngestDataflashResponse {
    #[builder(default, map(key(type = String, into), value(type = String, into)))]
    #[serde(
        rename = "units",
        skip_serializing_if = "std::collections::BTreeMap::is_empty",
        default
    )]
    units: std::collections::BTreeMap<String, String>,
    #[builder(default, list(item(type = super::ObjectLocator)))]
    #[serde(
        rename = "parquetObjectLocators",
        skip_serializing_if = "Vec::is_empty",
        default
    )]
    parquet_object_locators: Vec<super::ObjectLocator>,
    #[builder(into)]
    #[serde(rename = "timestampSeriesName")]
    timestamp_series_name: String,
    #[serde(rename = "timeUnit")]
    time_unit: super::TimeUnitSeconds,
    #[builder(
        default,
        custom(
            type = impl
            Into<Option<super::ObjectLocator>>,
            convert = |v|v.into().map(Box::new)
        )
    )]
    #[serde(rename = "avroLocator", skip_serializing_if = "Option::is_none", default)]
    avro_locator: Option<Box<super::ObjectLocator>>,
}
impl IngestDataflashResponse {
    /// Constructs a new instance of the type.
    #[inline]
    pub fn new(
        timestamp_series_name: impl Into<String>,
        time_unit: super::TimeUnitSeconds,
    ) -> Self {
        Self::builder()
            .timestamp_series_name(timestamp_series_name)
            .time_unit(time_unit)
            .build()
    }
    #[inline]
    pub fn units(&self) -> &std::collections::BTreeMap<String, String> {
        &self.units
    }
    /// Azure or S3-style blob locators of parquet files. Currently
    /// only a single file is supported, the list type is used for future compatibility.
    #[inline]
    pub fn parquet_object_locators(&self) -> &[super::ObjectLocator] {
        &*self.parquet_object_locators
    }
    /// The name of the column in the generated parquet file that contains the timestamp.
    #[inline]
    pub fn timestamp_series_name(&self) -> &str {
        &*self.timestamp_series_name
    }
    /// The unit of time for the timestamp column. Can only be seconds.
    #[inline]
    pub fn time_unit(&self) -> &super::TimeUnitSeconds {
        &self.time_unit
    }
    /// Azure or S3-style blob locator of avro file when avro processing is configured.
    /// This field is only set when the workflow is configured to write avro stream.
    #[inline]
    pub fn avro_locator(&self) -> Option<&super::ObjectLocator> {
        self.avro_locator.as_ref().map(|o| &**o)
    }
}