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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158

#[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 Event {
    #[serde(rename = "uuid")]
    uuid: conjure_object::Uuid,
    #[serde(rename = "rid")]
    rid: super::super::api::rids::EventRid,
    #[builder(default, set(item(type = super::super::scout::rids::api::AssetRid)))]
    #[serde(
        rename = "assetRids",
        skip_serializing_if = "std::collections::BTreeSet::is_empty",
        default
    )]
    asset_rids: std::collections::BTreeSet<super::super::scout::rids::api::AssetRid>,
    #[builder(default, set(item(type = super::EventOrigin)))]
    #[serde(
        rename = "origins",
        skip_serializing_if = "std::collections::BTreeSet::is_empty",
        default
    )]
    origins: std::collections::BTreeSet<super::EventOrigin>,
    #[builder(custom(type = super::super::api::Timestamp, convert = Box::new))]
    #[serde(rename = "timestamp")]
    timestamp: Box<super::super::api::Timestamp>,
    #[builder(
        custom(type = super::super::scout::run::api::Duration, convert = Box::new)
    )]
    #[serde(rename = "duration")]
    duration: Box<super::super::scout::run::api::Duration>,
    #[builder(into)]
    #[serde(rename = "name")]
    name: String,
    #[builder(into)]
    #[serde(rename = "description")]
    description: String,
    #[serde(rename = "type")]
    type_: super::EventType,
    #[builder(default, set(item(type = super::super::api::Label)))]
    #[serde(
        rename = "labels",
        skip_serializing_if = "std::collections::BTreeSet::is_empty",
        default
    )]
    labels: std::collections::BTreeSet<super::super::api::Label>,
    #[builder(
        default,
        map(
            key(type = super::super::api::PropertyName),
            value(type = super::super::api::PropertyValue)
        )
    )]
    #[serde(
        rename = "properties",
        skip_serializing_if = "std::collections::BTreeMap::is_empty",
        default
    )]
    properties: std::collections::BTreeMap<
        super::super::api::PropertyName,
        super::super::api::PropertyValue,
    >,
    #[serde(rename = "isArchived")]
    is_archived: bool,
    #[builder(default, into)]
    #[serde(rename = "createdBy", skip_serializing_if = "Option::is_none", default)]
    created_by: Option<super::super::scout::rids::api::UserRid>,
    #[builder(
        default,
        custom(
            type = impl
            Into<Option<super::EventDisposition>>,
            convert = |v|v.into().map(Box::new)
        )
    )]
    #[serde(rename = "disposition", skip_serializing_if = "Option::is_none", default)]
    disposition: Option<Box<super::EventDisposition>>,
}
impl Event {
    #[deprecated(note = "This field is deprecated. Use the rid field instead.\n")]
    #[inline]
    pub fn uuid(&self) -> conjure_object::Uuid {
        self.uuid
    }
    #[inline]
    pub fn rid(&self) -> &super::super::api::rids::EventRid {
        &self.rid
    }
    /// A set of asset rids associated with the event.
    #[inline]
    pub fn asset_rids(
        &self,
    ) -> &std::collections::BTreeSet<super::super::scout::rids::api::AssetRid> {
        &self.asset_rids
    }
    /// A set of origins associated with the event.
    #[inline]
    pub fn origins(&self) -> &std::collections::BTreeSet<super::EventOrigin> {
        &self.origins
    }
    #[inline]
    pub fn timestamp(&self) -> &super::super::api::Timestamp {
        &*self.timestamp
    }
    #[inline]
    pub fn duration(&self) -> &super::super::scout::run::api::Duration {
        &*self.duration
    }
    #[inline]
    pub fn name(&self) -> &str {
        &*self.name
    }
    #[inline]
    pub fn description(&self) -> &str {
        &*self.description
    }
    #[inline]
    pub fn type_(&self) -> &super::EventType {
        &self.type_
    }
    #[inline]
    pub fn labels(&self) -> &std::collections::BTreeSet<super::super::api::Label> {
        &self.labels
    }
    #[inline]
    pub fn properties(
        &self,
    ) -> &std::collections::BTreeMap<
        super::super::api::PropertyName,
        super::super::api::PropertyValue,
    > {
        &self.properties
    }
    #[inline]
    pub fn is_archived(&self) -> bool {
        self.is_archived
    }
    /// The user who created the event.
    /// This field may be missing for legacy events.
    #[inline]
    pub fn created_by(&self) -> Option<&super::super::scout::rids::api::UserRid> {
        self.created_by.as_ref().map(|o| &*o)
    }
    #[inline]
    pub fn disposition(&self) -> Option<&super::EventDisposition> {
        self.disposition.as_ref().map(|o| &**o)
    }
}