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

#[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 SearchMetadataRequest {
    #[builder(default, into)]
    #[serde(rename = "resourceTypes", skip_serializing_if = "Option::is_none", default)]
    resource_types: Option<std::collections::BTreeSet<super::ResourceType>>,
    #[builder(default, into)]
    #[serde(rename = "workspaces", skip_serializing_if = "Option::is_none", default)]
    workspaces: Option<
        std::collections::BTreeSet<super::super::super::api::rids::WorkspaceRid>,
    >,
    #[builder(default, into)]
    #[serde(rename = "searchText", skip_serializing_if = "Option::is_none", default)]
    search_text: Option<String>,
    #[builder(default, into)]
    #[serde(rename = "pageSize", skip_serializing_if = "Option::is_none", default)]
    page_size: Option<i32>,
    #[builder(default, into)]
    #[serde(rename = "pageToken", skip_serializing_if = "Option::is_none", default)]
    page_token: Option<super::super::super::api::Token>,
    #[serde(rename = "sortBy")]
    sort_by: super::MetadataSortField,
    #[builder(default, into)]
    #[serde(rename = "descending", skip_serializing_if = "Option::is_none", default)]
    descending: Option<bool>,
}
impl SearchMetadataRequest {
    /// Constructs a new instance of the type.
    #[inline]
    pub fn new(sort_by: super::MetadataSortField) -> Self {
        Self::builder().sort_by(sort_by).build()
    }
    /// If omitted, all resource types are included.
    #[inline]
    pub fn resource_types(
        &self,
    ) -> Option<&std::collections::BTreeSet<super::ResourceType>> {
        self.resource_types.as_ref().map(|o| &*o)
    }
    /// If omitted, results will come from all workspaces the user belongs to.
    #[inline]
    pub fn workspaces(
        &self,
    ) -> Option<
        &std::collections::BTreeSet<super::super::super::api::rids::WorkspaceRid>,
    > {
        self.workspaces.as_ref().map(|o| &*o)
    }
    /// Case-insensitive substring filter.
    #[inline]
    pub fn search_text(&self) -> Option<&str> {
        self.search_text.as_ref().map(|o| &**o)
    }
    /// Maximum number of items per page. Defaults to 1000 if not specified.
    #[inline]
    pub fn page_size(&self) -> Option<i32> {
        self.page_size.as_ref().map(|o| *o)
    }
    /// Token for fetching the next page of results.
    #[inline]
    pub fn page_token(&self) -> Option<&super::super::super::api::Token> {
        self.page_token.as_ref().map(|o| &*o)
    }
    #[inline]
    pub fn sort_by(&self) -> &super::MetadataSortField {
        &self.sort_by
    }
    /// If true, sort in descending order. Defaults to false.
    #[inline]
    pub fn descending(&self) -> Option<bool> {
        self.descending.as_ref().map(|o| *o)
    }
}