Skip to main content

nominal_api/conjure/objects/scout/datareview/api/
search_check_alerts_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 SearchCheckAlertsRequest {
16    #[builder(default, into)]
17    #[serde(rename = "nextPageToken", skip_serializing_if = "Option::is_none", default)]
18    next_page_token: Option<super::super::super::super::api::Token>,
19    #[builder(default, into)]
20    #[serde(rename = "pageSize", skip_serializing_if = "Option::is_none", default)]
21    page_size: Option<i32>,
22    #[builder(
23        default,
24        custom(
25            type = impl
26            Into<Option<super::SearchCheckAlertsSortOptions>>,
27            convert = |v|v.into().map(Box::new)
28        )
29    )]
30    #[serde(rename = "sortBy", skip_serializing_if = "Option::is_none", default)]
31    sort_by: Option<Box<super::SearchCheckAlertsSortOptions>>,
32    #[builder(default, into)]
33    #[serde(rename = "searchText", skip_serializing_if = "Option::is_none", default)]
34    search_text: Option<String>,
35    #[builder(
36        default,
37        custom(
38            type = impl
39            Into<Option<super::super::super::super::api::Timestamp>>,
40            convert = |v|v.into().map(Box::new)
41        )
42    )]
43    #[serde(rename = "after", skip_serializing_if = "Option::is_none", default)]
44    after: Option<Box<super::super::super::super::api::Timestamp>>,
45    #[builder(
46        default,
47        custom(
48            type = impl
49            Into<Option<super::super::super::super::api::Timestamp>>,
50            convert = |v|v.into().map(Box::new)
51        )
52    )]
53    #[serde(rename = "before", skip_serializing_if = "Option::is_none", default)]
54    before: Option<Box<super::super::super::super::api::Timestamp>>,
55    #[builder(default, into)]
56    #[serde(rename = "status", skip_serializing_if = "Option::is_none", default)]
57    status: Option<std::collections::BTreeSet<super::CheckAlertStatus>>,
58    #[builder(default, into)]
59    #[serde(rename = "checkRids", skip_serializing_if = "Option::is_none", default)]
60    check_rids: Option<
61        std::collections::BTreeSet<super::super::super::rids::api::CheckRid>,
62    >,
63    #[builder(default, into)]
64    #[serde(rename = "dataReviewRids", skip_serializing_if = "Option::is_none", default)]
65    data_review_rids: Option<
66        std::collections::BTreeSet<super::super::super::rids::api::DataReviewRid>,
67    >,
68    #[builder(default, into)]
69    #[serde(rename = "assigneeRids", skip_serializing_if = "Option::is_none", default)]
70    assignee_rids: Option<
71        std::collections::BTreeSet<super::super::super::rids::api::UserRid>,
72    >,
73    #[builder(default, into)]
74    #[serde(rename = "priorities", skip_serializing_if = "Option::is_none", default)]
75    priorities: Option<std::collections::BTreeSet<super::super::super::api::Priority>>,
76    #[builder(default, set(item(type = super::super::super::run::api::RunRid)))]
77    #[serde(
78        rename = "runRids",
79        skip_serializing_if = "std::collections::BTreeSet::is_empty",
80        default
81    )]
82    run_rids: std::collections::BTreeSet<super::super::super::run::api::RunRid>,
83    #[builder(default, set(item(type = super::super::super::rids::api::AssetRid)))]
84    #[serde(
85        rename = "assetRids",
86        skip_serializing_if = "std::collections::BTreeSet::is_empty",
87        default
88    )]
89    asset_rids: std::collections::BTreeSet<super::super::super::rids::api::AssetRid>,
90    #[builder(default, into)]
91    #[serde(
92        rename = "pinnedChecklistRefs",
93        skip_serializing_if = "Option::is_none",
94        default
95    )]
96    pinned_checklist_refs: Option<
97        std::collections::BTreeSet<super::super::super::checks::api::PinnedChecklistRef>,
98    >,
99    #[builder(default, into)]
100    #[serde(rename = "chartRids", skip_serializing_if = "Option::is_none", default)]
101    chart_rids: Option<
102        std::collections::BTreeSet<super::super::super::rids::api::VersionedVizId>,
103    >,
104    #[builder(default, into)]
105    #[serde(rename = "notebookRids", skip_serializing_if = "Option::is_none", default)]
106    notebook_rids: Option<
107        std::collections::BTreeSet<super::super::super::rids::api::NotebookRid>,
108    >,
109    #[builder(default, into)]
110    #[serde(rename = "showArchived", skip_serializing_if = "Option::is_none", default)]
111    show_archived: Option<bool>,
112    #[builder(default, into)]
113    #[serde(
114        rename = "archivedStatuses",
115        skip_serializing_if = "Option::is_none",
116        default
117    )]
118    archived_statuses: Option<
119        std::collections::BTreeSet<super::super::super::super::api::ArchivedStatus>,
120    >,
121}
122impl SearchCheckAlertsRequest {
123    /// Constructs a new instance of the type.
124    #[inline]
125    pub fn new() -> Self {
126        Self::builder().build()
127    }
128    #[inline]
129    pub fn next_page_token(&self) -> Option<&super::super::super::super::api::Token> {
130        self.next_page_token.as_ref().map(|o| &*o)
131    }
132    /// Defaults to 100. Will throw if larger than 1_000.
133    #[inline]
134    pub fn page_size(&self) -> Option<i32> {
135        self.page_size.as_ref().map(|o| *o)
136    }
137    /// If not present, will sort by start time in descending order.
138    #[inline]
139    pub fn sort_by(&self) -> Option<&super::SearchCheckAlertsSortOptions> {
140        self.sort_by.as_ref().map(|o| &**o)
141    }
142    /// Matches on check name
143    #[inline]
144    pub fn search_text(&self) -> Option<&str> {
145        self.search_text.as_ref().map(|o| &**o)
146    }
147    /// Filters to start times after this time, inclusive.
148    #[inline]
149    pub fn after(&self) -> Option<&super::super::super::super::api::Timestamp> {
150        self.after.as_ref().map(|o| &**o)
151    }
152    /// Filters to start times before this time, exclusive.
153    #[inline]
154    pub fn before(&self) -> Option<&super::super::super::super::api::Timestamp> {
155        self.before.as_ref().map(|o| &**o)
156    }
157    #[inline]
158    pub fn status(
159        &self,
160    ) -> Option<&std::collections::BTreeSet<super::CheckAlertStatus>> {
161        self.status.as_ref().map(|o| &*o)
162    }
163    #[inline]
164    pub fn check_rids(
165        &self,
166    ) -> Option<&std::collections::BTreeSet<super::super::super::rids::api::CheckRid>> {
167        self.check_rids.as_ref().map(|o| &*o)
168    }
169    #[inline]
170    pub fn data_review_rids(
171        &self,
172    ) -> Option<
173        &std::collections::BTreeSet<super::super::super::rids::api::DataReviewRid>,
174    > {
175        self.data_review_rids.as_ref().map(|o| &*o)
176    }
177    #[inline]
178    pub fn assignee_rids(
179        &self,
180    ) -> Option<&std::collections::BTreeSet<super::super::super::rids::api::UserRid>> {
181        self.assignee_rids.as_ref().map(|o| &*o)
182    }
183    #[inline]
184    pub fn priorities(
185        &self,
186    ) -> Option<&std::collections::BTreeSet<super::super::super::api::Priority>> {
187        self.priorities.as_ref().map(|o| &*o)
188    }
189    #[inline]
190    pub fn run_rids(
191        &self,
192    ) -> &std::collections::BTreeSet<super::super::super::run::api::RunRid> {
193        &self.run_rids
194    }
195    #[inline]
196    pub fn asset_rids(
197        &self,
198    ) -> &std::collections::BTreeSet<super::super::super::rids::api::AssetRid> {
199        &self.asset_rids
200    }
201    #[inline]
202    pub fn pinned_checklist_refs(
203        &self,
204    ) -> Option<
205        &std::collections::BTreeSet<super::super::super::checks::api::PinnedChecklistRef>,
206    > {
207        self.pinned_checklist_refs.as_ref().map(|o| &*o)
208    }
209    #[deprecated(note = "charts are no longer versioned resources.")]
210    #[inline]
211    pub fn chart_rids(
212        &self,
213    ) -> Option<
214        &std::collections::BTreeSet<super::super::super::rids::api::VersionedVizId>,
215    > {
216        self.chart_rids.as_ref().map(|o| &*o)
217    }
218    #[inline]
219    pub fn notebook_rids(
220        &self,
221    ) -> Option<
222        &std::collections::BTreeSet<super::super::super::rids::api::NotebookRid>,
223    > {
224        self.notebook_rids.as_ref().map(|o| &*o)
225    }
226    /// To be deprecated. Use archivedStatuses instead. If true, includes archived check alerts in the search
227    /// results. If not present or false, will not show archived data reviews in search results
228    #[inline]
229    pub fn show_archived(&self) -> Option<bool> {
230        self.show_archived.as_ref().map(|o| *o)
231    }
232    /// Filters search on check alerts based on the archived statuses provided.
233    /// Default is NOT_ARCHIVED only if none are provided.
234    #[inline]
235    pub fn archived_statuses(
236        &self,
237    ) -> Option<
238        &std::collections::BTreeSet<super::super::super::super::api::ArchivedStatus>,
239    > {
240        self.archived_statuses.as_ref().map(|o| &*o)
241    }
242}