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

#[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 SearchChannelsRequest {
    #[builder(into)]
    #[serde(rename = "fuzzySearchText")]
    fuzzy_search_text: String,
    #[builder(default, into)]
    #[serde(rename = "prefix", skip_serializing_if = "Option::is_none", default)]
    prefix: Option<String>,
    #[builder(default, set(item(type = String, into)))]
    #[serde(
        rename = "exactMatch",
        skip_serializing_if = "std::collections::BTreeSet::is_empty",
        default
    )]
    exact_match: std::collections::BTreeSet<String>,
    #[builder(default, set(item(type = super::super::super::api::rids::DataSourceRid)))]
    #[serde(
        rename = "dataSources",
        skip_serializing_if = "std::collections::BTreeSet::is_empty",
        default
    )]
    data_sources: std::collections::BTreeSet<
        super::super::super::api::rids::DataSourceRid,
    >,
    #[builder(default, set(item(type = super::super::super::api::SeriesDataType)))]
    #[serde(
        rename = "dataTypes",
        skip_serializing_if = "std::collections::BTreeSet::is_empty",
        default
    )]
    data_types: std::collections::BTreeSet<super::super::super::api::SeriesDataType>,
    #[builder(default, into)]
    #[serde(
        rename = "previouslySelectedChannels",
        skip_serializing_if = "Option::is_none",
        default
    )]
    previously_selected_channels: Option<
        std::collections::BTreeMap<
            super::super::super::api::rids::DataSourceRid,
            std::collections::BTreeSet<super::super::super::api::Channel>,
        >,
    >,
    #[builder(default, into)]
    #[serde(rename = "nextPageToken", skip_serializing_if = "Option::is_none", default)]
    next_page_token: Option<super::super::super::api::Token>,
    #[builder(default, into)]
    #[serde(rename = "pageSize", skip_serializing_if = "Option::is_none", default)]
    page_size: Option<i32>,
}
impl SearchChannelsRequest {
    /// Constructs a new instance of the type.
    #[inline]
    pub fn new(fuzzy_search_text: impl Into<String>) -> Self {
        Self::builder().fuzzy_search_text(fuzzy_search_text).build()
    }
    #[inline]
    pub fn fuzzy_search_text(&self) -> &str {
        &*self.fuzzy_search_text
    }
    #[deprecated(note = "Use `searchHierarchical` instead. Will be ignored.\n")]
    #[inline]
    pub fn prefix(&self) -> Option<&str> {
        self.prefix.as_ref().map(|o| &**o)
    }
    /// Will return only channels that contain all strings specified as exact matches (case insensitive).
    #[inline]
    pub fn exact_match(&self) -> &std::collections::BTreeSet<String> {
        &self.exact_match
    }
    #[inline]
    pub fn data_sources(
        &self,
    ) -> &std::collections::BTreeSet<super::super::super::api::rids::DataSourceRid> {
        &self.data_sources
    }
    /// Filter to only channels with these data types. An empty set means no filtering (all data types included).
    #[inline]
    pub fn data_types(
        &self,
    ) -> &std::collections::BTreeSet<super::super::super::api::SeriesDataType> {
        &self.data_types
    }
    #[deprecated(note = "Will be ignored.\n")]
    #[inline]
    pub fn previously_selected_channels(
        &self,
    ) -> Option<
        &std::collections::BTreeMap<
            super::super::super::api::rids::DataSourceRid,
            std::collections::BTreeSet<super::super::super::api::Channel>,
        >,
    > {
        self.previously_selected_channels.as_ref().map(|o| &*o)
    }
    #[inline]
    pub fn next_page_token(&self) -> Option<&super::super::super::api::Token> {
        self.next_page_token.as_ref().map(|o| &*o)
    }
    /// Defaults to 1000. Will throw if larger than 1000.
    #[inline]
    pub fn page_size(&self) -> Option<i32> {
        self.page_size.as_ref().map(|o| *o)
    }
}