Skip to main content

nominal_api/conjure/objects/scout/notebook/api/
search_notebooks_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 SearchNotebooksRequest {
16    #[builder(custom(type = super::SearchNotebooksQuery, convert = Box::new))]
17    #[serde(rename = "query")]
18    query: Box<super::SearchNotebooksQuery>,
19    #[serde(rename = "showDrafts")]
20    show_drafts: bool,
21    #[builder(default, into)]
22    #[serde(rename = "showArchived", skip_serializing_if = "Option::is_none", default)]
23    show_archived: Option<bool>,
24    #[builder(
25        default,
26        custom(
27            type = impl
28            Into<Option<super::SortBy>>,
29            convert = |v|v.into().map(Box::new)
30        )
31    )]
32    #[serde(rename = "sortBy", skip_serializing_if = "Option::is_none", default)]
33    sort_by: Option<Box<super::SortBy>>,
34    #[builder(default, into)]
35    #[serde(rename = "nextPageToken", skip_serializing_if = "Option::is_none", default)]
36    next_page_token: Option<super::super::super::super::api::Token>,
37    #[builder(default, into)]
38    #[serde(rename = "pageSize", skip_serializing_if = "Option::is_none", default)]
39    page_size: Option<i32>,
40}
41impl SearchNotebooksRequest {
42    /// Constructs a new instance of the type.
43    #[inline]
44    pub fn new(query: super::SearchNotebooksQuery, show_drafts: bool) -> Self {
45        Self::builder().query(query).show_drafts(show_drafts).build()
46    }
47    #[inline]
48    pub fn query(&self) -> &super::SearchNotebooksQuery {
49        &*self.query
50    }
51    /// Soon to be deprecated. Compose a draftState filter within SearchNotebooksQuery instead
52    #[inline]
53    pub fn show_drafts(&self) -> bool {
54        self.show_drafts
55    }
56    /// Soon to be deprecated. Compose an archived filter within SearchNotebooksQuery instead
57    #[inline]
58    pub fn show_archived(&self) -> Option<bool> {
59        self.show_archived.as_ref().map(|o| *o)
60    }
61    /// UPDATED_AT descending by default
62    #[inline]
63    pub fn sort_by(&self) -> Option<&super::SortBy> {
64        self.sort_by.as_ref().map(|o| &**o)
65    }
66    #[inline]
67    pub fn next_page_token(&self) -> Option<&super::super::super::super::api::Token> {
68        self.next_page_token.as_ref().map(|o| &*o)
69    }
70    /// Defaults to 100. Will throw if larger than 1000.
71    #[inline]
72    pub fn page_size(&self) -> Option<i32> {
73        self.page_size.as_ref().map(|o| *o)
74    }
75}