nominal_api/conjure/objects/scout/metadata/
search_metadata_request.rs

1#[derive(
2    Debug,
3    Clone,
4    conjure_object::serde::Serialize,
5    conjure_object::serde::Deserialize,
6    PartialEq,
7    Eq,
8    PartialOrd,
9    Ord,
10    Hash
11)]
12#[serde(crate = "conjure_object::serde")]
13#[conjure_object::private::staged_builder::staged_builder]
14#[builder(crate = conjure_object::private::staged_builder, update, inline)]
15pub struct SearchMetadataRequest {
16    #[builder(default, into)]
17    #[serde(rename = "resourceTypes", skip_serializing_if = "Option::is_none", default)]
18    resource_types: Option<std::collections::BTreeSet<super::ResourceType>>,
19    #[builder(default, into)]
20    #[serde(rename = "workspaces", skip_serializing_if = "Option::is_none", default)]
21    workspaces: Option<std::collections::BTreeSet<conjure_object::ResourceIdentifier>>,
22    #[builder(default, into)]
23    #[serde(rename = "searchText", skip_serializing_if = "Option::is_none", default)]
24    search_text: Option<String>,
25    #[builder(default, into)]
26    #[serde(rename = "pageSize", skip_serializing_if = "Option::is_none", default)]
27    page_size: Option<i32>,
28    #[builder(default, into)]
29    #[serde(rename = "pageToken", skip_serializing_if = "Option::is_none", default)]
30    page_token: Option<String>,
31    #[serde(rename = "sortBy")]
32    sort_by: super::MetadataSortField,
33    #[builder(default, into)]
34    #[serde(rename = "descending", skip_serializing_if = "Option::is_none", default)]
35    descending: Option<bool>,
36}
37impl SearchMetadataRequest {
38    /// Constructs a new instance of the type.
39    #[inline]
40    pub fn new(sort_by: super::MetadataSortField) -> Self {
41        Self::builder().sort_by(sort_by).build()
42    }
43    /// If omitted, all resource types are included.
44    #[inline]
45    pub fn resource_types(
46        &self,
47    ) -> Option<&std::collections::BTreeSet<super::ResourceType>> {
48        self.resource_types.as_ref().map(|o| &*o)
49    }
50    /// If omitted, results will come from all workspaces the user belongs to.
51    #[inline]
52    pub fn workspaces(
53        &self,
54    ) -> Option<&std::collections::BTreeSet<conjure_object::ResourceIdentifier>> {
55        self.workspaces.as_ref().map(|o| &*o)
56    }
57    /// Case-insensitive substring filter.
58    #[inline]
59    pub fn search_text(&self) -> Option<&str> {
60        self.search_text.as_ref().map(|o| &**o)
61    }
62    /// Maximum number of items per page. Defaults to 1000 if not specified.
63    #[inline]
64    pub fn page_size(&self) -> Option<i32> {
65        self.page_size.as_ref().map(|o| *o)
66    }
67    /// Token for fetching the next page of results.
68    #[inline]
69    pub fn page_token(&self) -> Option<&str> {
70        self.page_token.as_ref().map(|o| &**o)
71    }
72    #[inline]
73    pub fn sort_by(&self) -> &super::MetadataSortField {
74        &self.sort_by
75    }
76    /// If true, sort in descending order. Defaults to false.
77    #[inline]
78    pub fn descending(&self) -> Option<bool> {
79        self.descending.as_ref().map(|o| *o)
80    }
81}
nominal_api/conjure/objects/scout/metadata/search_metadata_request.rs

nominal_api/conjure/objects/scout/metadata/
search_metadata_request.rs
