Skip to main content

nominal_api/conjure/objects/scout/asset/api/
search_assets_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 SearchAssetsRequest {
16    #[builder(custom(type = super::AssetSortOptions, convert = Box::new))]
17    #[serde(rename = "sort")]
18    sort: Box<super::AssetSortOptions>,
19    #[builder(default, into)]
20    #[serde(rename = "pageSize", skip_serializing_if = "Option::is_none", default)]
21    page_size: Option<i32>,
22    #[builder(default, into)]
23    #[serde(rename = "nextPageToken", skip_serializing_if = "Option::is_none", default)]
24    next_page_token: Option<super::super::super::super::api::Token>,
25    #[builder(custom(type = super::SearchAssetsQuery, convert = Box::new))]
26    #[serde(rename = "query")]
27    query: Box<super::SearchAssetsQuery>,
28    #[builder(default, into)]
29    #[serde(
30        rename = "archivedStatuses",
31        skip_serializing_if = "Option::is_none",
32        default
33    )]
34    archived_statuses: Option<
35        std::collections::BTreeSet<super::super::super::super::api::ArchivedStatus>,
36    >,
37}
38impl SearchAssetsRequest {
39    /// Constructs a new instance of the type.
40    #[inline]
41    pub fn new(sort: super::AssetSortOptions, query: super::SearchAssetsQuery) -> Self {
42        Self::builder().sort(sort).query(query).build()
43    }
44    #[inline]
45    pub fn sort(&self) -> &super::AssetSortOptions {
46        &*self.sort
47    }
48    /// Page sizes greater than 10_000 will be rejected. Default pageSize is 100.
49    #[inline]
50    pub fn page_size(&self) -> Option<i32> {
51        self.page_size.as_ref().map(|o| *o)
52    }
53    #[inline]
54    pub fn next_page_token(&self) -> Option<&super::super::super::super::api::Token> {
55        self.next_page_token.as_ref().map(|o| &*o)
56    }
57    #[inline]
58    pub fn query(&self) -> &super::SearchAssetsQuery {
59        &*self.query
60    }
61    /// Default search status is NOT_ARCHIVED if none are provided. Allows for including archived assets in search.
62    #[inline]
63    pub fn archived_statuses(
64        &self,
65    ) -> Option<
66        &std::collections::BTreeSet<super::super::super::super::api::ArchivedStatus>,
67    > {
68        self.archived_statuses.as_ref().map(|o| &*o)
69    }
70}