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

#[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 SearchHierarchicalChannelsRequest {
    #[builder(default, list(item(type = String, into)))]
    #[serde(rename = "parent", skip_serializing_if = "Vec::is_empty", default)]
    parent: Vec<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,
        custom(
            type = impl
            Into<Option<super::DataScopeFilters>>,
            convert = |v|v.into().map(Box::new)
        )
    )]
    #[serde(
        rename = "dataScopeFilters",
        skip_serializing_if = "Option::is_none",
        default
    )]
    data_scope_filters: Option<Box<super::DataScopeFilters>>,
}
impl SearchHierarchicalChannelsRequest {
    /// Constructs a new instance of the type.
    #[inline]
    pub fn new() -> Self {
        Self::builder().build()
    }
    /// The parent (represented as a list of parts) to search under. If empty, will return all top-level channels.
    #[inline]
    pub fn parent(&self) -> &[String] {
        &*self.parent
    }
    #[inline]
    pub fn data_sources(
        &self,
    ) -> &std::collections::BTreeSet<super::super::super::api::rids::DataSourceRid> {
        &self.data_sources
    }
    /// When dataScopeFilters are specified, the set of data sources must match the set of data sources in
    /// DataScopeFilters#tags
    #[inline]
    pub fn data_scope_filters(&self) -> Option<&super::DataScopeFilters> {
        self.data_scope_filters.as_ref().map(|o| &**o)
    }
}