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

nominal_api/conjure/objects/scout/datareview/api/
check_alerts_histogram_request.rs
