Skip to main content

nominal_api/conjure/objects/scout/checks/api/
check.rs

1#[derive(
2    Debug,
3    Clone,
4    conjure_object::serde::Serialize,
5    conjure_object::serde::Deserialize,
6    conjure_object::private::DeriveWith
7)]
8#[serde(crate = "conjure_object::serde")]
9#[derive_with(PartialEq, Eq, PartialOrd, Ord, Hash)]
10#[conjure_object::private::staged_builder::staged_builder]
11#[builder(crate = conjure_object::private::staged_builder, update, inline)]
12pub struct Check {
13    #[serde(rename = "rid")]
14    rid: super::super::super::rids::api::CheckRid,
15    #[serde(rename = "checkLineageRid")]
16    check_lineage_rid: super::super::super::rids::api::CheckLineageRid,
17    #[builder(into)]
18    #[serde(rename = "title")]
19    title: String,
20    #[builder(into)]
21    #[serde(rename = "description")]
22    description: String,
23    #[builder(default, into)]
24    #[serde(
25        rename = "autoGeneratedTitle",
26        skip_serializing_if = "Option::is_none",
27        default
28    )]
29    auto_generated_title: Option<String>,
30    #[builder(default, into)]
31    #[serde(
32        rename = "autoGeneratedDescription",
33        skip_serializing_if = "Option::is_none",
34        default
35    )]
36    auto_generated_description: Option<String>,
37    #[serde(rename = "priority")]
38    priority: super::super::super::api::Priority,
39    #[serde(rename = "generatedEventType")]
40    generated_event_type: super::super::super::super::event::EventType,
41    #[builder(default, into)]
42    #[serde(
43        rename = "generatedEventLabels",
44        skip_serializing_if = "Option::is_none",
45        default
46    )]
47    generated_event_labels: Option<
48        std::collections::BTreeSet<super::super::super::super::api::Label>,
49    >,
50    #[builder(
51        default,
52        custom(
53            type = impl
54            Into<Option<super::super::super::rids::api::VersionedVizId>>,
55            convert = |v|v.into().map(Box::new)
56        )
57    )]
58    #[serde(rename = "chart", skip_serializing_if = "Option::is_none", default)]
59    chart: Option<Box<super::super::super::rids::api::VersionedVizId>>,
60    #[builder(
61        default,
62        custom(
63            type = impl
64            Into<Option<super::CheckCondition>>,
65            convert = |v|v.into().map(Box::new)
66        )
67    )]
68    #[serde(rename = "condition", skip_serializing_if = "Option::is_none", default)]
69    condition: Option<Box<super::CheckCondition>>,
70}
71impl Check {
72    #[inline]
73    pub fn rid(&self) -> &super::super::super::rids::api::CheckRid {
74        &self.rid
75    }
76    #[inline]
77    pub fn check_lineage_rid(&self) -> &super::super::super::rids::api::CheckLineageRid {
78        &self.check_lineage_rid
79    }
80    #[inline]
81    pub fn title(&self) -> &str {
82        &*self.title
83    }
84    #[inline]
85    pub fn description(&self) -> &str {
86        &*self.description
87    }
88    #[inline]
89    pub fn auto_generated_title(&self) -> Option<&str> {
90        self.auto_generated_title.as_ref().map(|o| &**o)
91    }
92    #[inline]
93    pub fn auto_generated_description(&self) -> Option<&str> {
94        self.auto_generated_description.as_ref().map(|o| &**o)
95    }
96    #[inline]
97    pub fn priority(&self) -> &super::super::super::api::Priority {
98        &self.priority
99    }
100    #[inline]
101    pub fn generated_event_type(&self) -> &super::super::super::super::event::EventType {
102        &self.generated_event_type
103    }
104    #[inline]
105    pub fn generated_event_labels(
106        &self,
107    ) -> Option<&std::collections::BTreeSet<super::super::super::super::api::Label>> {
108        self.generated_event_labels.as_ref().map(|o| &*o)
109    }
110    #[deprecated(note = "charts are no longer versioned resources.")]
111    #[inline]
112    pub fn chart(&self) -> Option<&super::super::super::rids::api::VersionedVizId> {
113        self.chart.as_ref().map(|o| &**o)
114    }
115    /// If omitted, this check represents a manual check.
116    #[inline]
117    pub fn condition(&self) -> Option<&super::CheckCondition> {
118        self.condition.as_ref().map(|o| &**o)
119    }
120}