Skip to main content

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