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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125

#[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 Connection {
    #[serde(rename = "rid")]
    rid: super::ConnectionRid,
    #[builder(into)]
    #[serde(rename = "displayName")]
    display_name: String,
    #[builder(default, into)]
    #[serde(rename = "description", skip_serializing_if = "Option::is_none", default)]
    description: Option<String>,
    #[builder(custom(type = super::ConnectionDetails, convert = Box::new))]
    #[serde(rename = "connectionDetails")]
    connection_details: Box<super::ConnectionDetails>,
    #[builder(
        default,
        set(item(type = super::super::super::super::super::api::TagName))
    )]
    #[serde(
        rename = "requiredTagNames",
        skip_serializing_if = "std::collections::BTreeSet::is_empty",
        default
    )]
    required_tag_names: std::collections::BTreeSet<
        super::super::super::super::super::api::TagName,
    >,
    #[builder(default, map(key(type = String, into), value(type = String, into)))]
    #[serde(
        rename = "metadata",
        skip_serializing_if = "std::collections::BTreeMap::is_empty",
        default
    )]
    metadata: std::collections::BTreeMap<String, String>,
    #[builder(
        default,
        custom(
            type = impl
            Into<Option<super::ScrapingConfig>>,
            convert = |v|v.into().map(Box::new)
        )
    )]
    #[serde(rename = "scraping", skip_serializing_if = "Option::is_none", default)]
    scraping: Option<Box<super::ScrapingConfig>>,
    #[serde(rename = "shouldScrape")]
    should_scrape: bool,
    #[builder(
        default,
        custom(
            type = impl
            Into<Option<super::LimitsConfig>>,
            convert = |v|v.into().map(Box::new)
        )
    )]
    #[serde(rename = "limits", skip_serializing_if = "Option::is_none", default)]
    limits: Option<Box<super::LimitsConfig>>,
    #[builder(custom(type = super::ConnectionStatus, convert = Box::new))]
    #[serde(rename = "connectionStatus")]
    connection_status: Box<super::ConnectionStatus>,
    #[serde(rename = "isArchived")]
    is_archived: bool,
}
impl Connection {
    #[inline]
    pub fn rid(&self) -> &super::ConnectionRid {
        &self.rid
    }
    /// The display name of the connection. For example: "Nominal production TimescaleDB"
    #[inline]
    pub fn display_name(&self) -> &str {
        &*self.display_name
    }
    #[inline]
    pub fn description(&self) -> Option<&str> {
        self.description.as_ref().map(|o| &**o)
    }
    #[inline]
    pub fn connection_details(&self) -> &super::ConnectionDetails {
        &*self.connection_details
    }
    /// Additional tag names that should be supplied to construct a fully qualified series. These are suggested,
    /// rather than strictly required.
    #[inline]
    pub fn required_tag_names(
        &self,
    ) -> &std::collections::BTreeSet<super::super::super::super::super::api::TagName> {
        &self.required_tag_names
    }
    #[inline]
    pub fn metadata(&self) -> &std::collections::BTreeMap<String, String> {
        &self.metadata
    }
    #[inline]
    pub fn scraping(&self) -> Option<&super::ScrapingConfig> {
        self.scraping.as_ref().map(|o| &**o)
    }
    /// The connection will be scraped iff this flag is set and scrapingConfig is present.
    #[inline]
    pub fn should_scrape(&self) -> bool {
        self.should_scrape
    }
    #[inline]
    pub fn limits(&self) -> Option<&super::LimitsConfig> {
        self.limits.as_ref().map(|o| &**o)
    }
    #[inline]
    pub fn connection_status(&self) -> &super::ConnectionStatus {
        &*self.connection_status
    }
    #[inline]
    pub fn is_archived(&self) -> bool {
        self.is_archived
    }
}