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<std::collections::BTreeSet<String>>,
48    #[builder(
49        default,
50        custom(
51            type = impl
52            Into<Option<super::super::super::rids::api::VersionedVizId>>,
53            convert = |v|v.into().map(Box::new)
54        )
55    )]
56    #[serde(rename = "chart", skip_serializing_if = "Option::is_none", default)]
57    chart: Option<Box<super::super::super::rids::api::VersionedVizId>>,
58    #[builder(
59        default,
60        custom(
61            type = impl
62            Into<Option<super::CheckCondition>>,
63            convert = |v|v.into().map(Box::new)
64        )
65    )]
66    #[serde(rename = "condition", skip_serializing_if = "Option::is_none", default)]
67    condition: Option<Box<super::CheckCondition>>,
68}
69impl Check {
70    #[inline]
71    pub fn rid(&self) -> &super::super::super::rids::api::CheckRid {
72        &self.rid
73    }
74    #[inline]
75    pub fn check_lineage_rid(&self) -> &super::super::super::rids::api::CheckLineageRid {
76        &self.check_lineage_rid
77    }
78    #[inline]
79    pub fn title(&self) -> &str {
80        &*self.title
81    }
82    #[inline]
83    pub fn description(&self) -> &str {
84        &*self.description
85    }
86    #[inline]
87    pub fn auto_generated_title(&self) -> Option<&str> {
88        self.auto_generated_title.as_ref().map(|o| &**o)
89    }
90    #[inline]
91    pub fn auto_generated_description(&self) -> Option<&str> {
92        self.auto_generated_description.as_ref().map(|o| &**o)
93    }
94    #[inline]
95    pub fn priority(&self) -> &super::super::super::api::Priority {
96        &self.priority
97    }
98    #[inline]
99    pub fn generated_event_type(&self) -> &super::super::super::super::event::EventType {
100        &self.generated_event_type
101    }
102    #[inline]
103    pub fn generated_event_labels(&self) -> Option<&std::collections::BTreeSet<String>> {
104        self.generated_event_labels.as_ref().map(|o| &*o)
105    }
106    #[deprecated(note = "charts are no longer versioned resources.")]
107    #[inline]
108    pub fn chart(&self) -> Option<&super::super::super::rids::api::VersionedVizId> {
109        self.chart.as_ref().map(|o| &**o)
110    }
111    /// If omitted, this check represents a manual check.
112    #[inline]
113    pub fn condition(&self) -> Option<&super::CheckCondition> {
114        self.condition.as_ref().map(|o| &**o)
115    }
116}