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
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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

/// Fields that are empty will be treated as a no-op update.
#[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 UpdateConnectionRequest {
    #[builder(default, into)]
    #[serde(rename = "name", skip_serializing_if = "Option::is_none", default)]
    name: Option<String>,
    #[builder(default, into)]
    #[serde(rename = "description", skip_serializing_if = "Option::is_none", default)]
    description: Option<String>,
    #[builder(default, into)]
    #[serde(rename = "metadata", skip_serializing_if = "Option::is_none", default)]
    metadata: Option<std::collections::BTreeMap<String, String>>,
    #[builder(
        default,
        custom(
            type = impl
            Into<Option<super::ConnectionDetails>>,
            convert = |v|v.into().map(Box::new)
        )
    )]
    #[serde(
        rename = "connectionDetails",
        skip_serializing_if = "Option::is_none",
        default
    )]
    connection_details: Option<Box<super::ConnectionDetails>>,
    #[builder(default, into)]
    #[serde(
        rename = "requiredTagNames",
        skip_serializing_if = "Option::is_none",
        default
    )]
    required_tag_names: Option<
        std::collections::BTreeSet<super::super::super::super::super::api::TagName>,
    >,
    #[builder(default, into)]
    #[serde(
        rename = "availableTagValues",
        skip_serializing_if = "Option::is_none",
        default
    )]
    available_tag_values: Option<
        std::collections::BTreeMap<
            super::super::super::super::super::api::TagName,
            std::collections::BTreeSet<super::super::super::super::super::api::TagValue>,
        >,
    >,
    #[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>>,
    #[builder(default, into)]
    #[serde(rename = "shouldScrape", skip_serializing_if = "Option::is_none", default)]
    should_scrape: Option<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>>,
}
impl UpdateConnectionRequest {
    /// Constructs a new instance of the type.
    #[inline]
    pub fn new() -> Self {
        Self::builder().build()
    }
    #[inline]
    pub fn name(&self) -> Option<&str> {
        self.name.as_ref().map(|o| &**o)
    }
    #[inline]
    pub fn description(&self) -> Option<&str> {
        self.description.as_ref().map(|o| &**o)
    }
    #[inline]
    pub fn metadata(&self) -> Option<&std::collections::BTreeMap<String, String>> {
        self.metadata.as_ref().map(|o| &*o)
    }
    #[inline]
    pub fn connection_details(&self) -> Option<&super::ConnectionDetails> {
        self.connection_details.as_ref().map(|o| &**o)
    }
    #[inline]
    pub fn required_tag_names(
        &self,
    ) -> Option<
        &std::collections::BTreeSet<super::super::super::super::super::api::TagName>,
    > {
        self.required_tag_names.as_ref().map(|o| &*o)
    }
    /// In most cases, this does not to be set by the user. Throws if populated for Nominal connections, which
    /// have their tags automatically indexed in the underlying database. Tags for external connections are
    /// periodically scraped. Tags should only be updated manually for Visual crossing connections.
    #[inline]
    pub fn available_tag_values(
        &self,
    ) -> Option<
        &std::collections::BTreeMap<
            super::super::super::super::super::api::TagName,
            std::collections::BTreeSet<super::super::super::super::super::api::TagValue>,
        >,
    > {
        self.available_tag_values.as_ref().map(|o| &*o)
    }
    #[inline]
    pub fn scraping(&self) -> Option<&super::ScrapingConfig> {
        self.scraping.as_ref().map(|o| &**o)
    }
    #[inline]
    pub fn should_scrape(&self) -> Option<bool> {
        self.should_scrape.as_ref().map(|o| *o)
    }
    #[inline]
    pub fn limits(&self) -> Option<&super::LimitsConfig> {
        self.limits.as_ref().map(|o| &**o)
    }
}