nominal-api 0.1240.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

/// A logical grouping of series.
#[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 NominalDataSource {
    #[serde(rename = "rid")]
    rid: super::super::super::super::api::rids::NominalDataSourceRid,
    #[serde(rename = "id")]
    id: super::NominalDataSourceId,
    #[builder(default, into)]
    #[serde(rename = "description", skip_serializing_if = "Option::is_none", default)]
    description: Option<String>,
    #[builder(default, into)]
    #[serde(
        rename = "dataLastWrittenAt",
        skip_serializing_if = "Option::is_none",
        default
    )]
    data_last_written_at: Option<conjure_object::DateTime<conjure_object::Utc>>,
    #[serde(rename = "granularity")]
    granularity: super::super::super::super::api::Granularity,
    #[builder(default, into)]
    #[serde(
        rename = "inMemoryStreamingEnabled",
        skip_serializing_if = "Option::is_none",
        default
    )]
    in_memory_streaming_enabled: Option<bool>,
}
impl NominalDataSource {
    /// Constructs a new instance of the type.
    #[inline]
    pub fn new(
        rid: super::super::super::super::api::rids::NominalDataSourceRid,
        id: super::NominalDataSourceId,
        granularity: super::super::super::super::api::Granularity,
    ) -> Self {
        Self::builder().rid(rid).id(id).granularity(granularity).build()
    }
    #[inline]
    pub fn rid(&self) -> &super::super::super::super::api::rids::NominalDataSourceRid {
        &self.rid
    }
    #[inline]
    pub fn id(&self) -> &super::NominalDataSourceId {
        &self.id
    }
    #[inline]
    pub fn description(&self) -> Option<&str> {
        self.description.as_ref().map(|o| &**o)
    }
    /// Returns the approximate timestamp at which data was written to the data source.
    /// Will be accurate to within 1 minute.
    #[inline]
    pub fn data_last_written_at(
        &self,
    ) -> Option<conjure_object::DateTime<conjure_object::Utc>> {
        self.data_last_written_at.as_ref().map(|o| *o)
    }
    #[inline]
    pub fn granularity(&self) -> &super::super::super::super::api::Granularity {
        &self.granularity
    }
    #[inline]
    pub fn in_memory_streaming_enabled(&self) -> Option<bool> {
        self.in_memory_streaming_enabled.as_ref().map(|o| *o)
    }
}