nominal-api 0.1239.0

API bindings for the Nominal platform
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102

#[derive(
    Debug,
    Clone,
    conjure_object::serde::Serialize,
    conjure_object::serde::Deserialize,
    PartialEq,
    Eq,
    PartialOrd,
    Ord,
    Hash
)]
#[serde(crate = "conjure_object::serde")]
#[conjure_object::private::staged_builder::staged_builder]
#[builder(crate = conjure_object::private::staged_builder, update, inline)]
pub struct AlertMessageFields {
    #[builder(into)]
    #[serde(rename = "assetTitle")]
    asset_title: String,
    #[builder(into)]
    #[serde(rename = "checkTitle")]
    check_title: String,
    #[builder(into)]
    #[serde(rename = "checkDescription")]
    check_description: String,
    #[builder(into)]
    #[serde(rename = "checklistTitle")]
    checklist_title: String,
    #[serde(rename = "assetRid")]
    asset_rid: super::super::super::rids::api::AssetRid,
    #[serde(rename = "checkLineageRid")]
    check_lineage_rid: super::super::super::rids::api::CheckLineageRid,
    #[builder(default, into)]
    #[serde(rename = "workbookUrl", skip_serializing_if = "Option::is_none", default)]
    workbook_url: Option<String>,
    #[builder(default, into)]
    #[serde(rename = "alertUrl", skip_serializing_if = "Option::is_none", default)]
    alert_url: Option<String>,
    #[serde(rename = "eventType")]
    event_type: super::super::super::super::event::EventType,
    #[serde(rename = "priority")]
    priority: super::super::super::api::Priority,
    #[builder(default, list(item(type = super::super::super::super::api::Label)))]
    #[serde(rename = "labels", skip_serializing_if = "Vec::is_empty", default)]
    labels: Vec<super::super::super::super::api::Label>,
    #[serde(rename = "alertType")]
    alert_type: super::AlertType,
}
impl AlertMessageFields {
    #[inline]
    pub fn asset_title(&self) -> &str {
        &*self.asset_title
    }
    #[inline]
    pub fn check_title(&self) -> &str {
        &*self.check_title
    }
    #[inline]
    pub fn check_description(&self) -> &str {
        &*self.check_description
    }
    #[inline]
    pub fn checklist_title(&self) -> &str {
        &*self.checklist_title
    }
    #[inline]
    pub fn asset_rid(&self) -> &super::super::super::rids::api::AssetRid {
        &self.asset_rid
    }
    #[inline]
    pub fn check_lineage_rid(&self) -> &super::super::super::rids::api::CheckLineageRid {
        &self.check_lineage_rid
    }
    /// Appended to the end of the message as a button (if supported) or as a text hyperlink.
    #[inline]
    pub fn workbook_url(&self) -> Option<&str> {
        self.workbook_url.as_ref().map(|o| &**o)
    }
    /// Appended to the end of the message as a button (if supported) or as a text hyperlink.
    #[inline]
    pub fn alert_url(&self) -> Option<&str> {
        self.alert_url.as_ref().map(|o| &**o)
    }
    /// Will be prefixed in title and indicated by an icon.
    #[inline]
    pub fn event_type(&self) -> &super::super::super::super::event::EventType {
        &self.event_type
    }
    #[inline]
    pub fn priority(&self) -> &super::super::super::api::Priority {
        &self.priority
    }
    /// Currently exposed as 'tags' on the frontend to match Opsgenie naming. Used by some integrations to filter/route messages.
    #[inline]
    pub fn labels(&self) -> &[super::super::super::super::api::Label] {
        &*self.labels
    }
    /// Determines execution status of the alert, between success, failure, and execution error.
    #[inline]
    pub fn alert_type(&self) -> &super::AlertType {
        &self.alert_type
    }
}