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

#[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 UpdateEvent {
    #[serde(rename = "uuid")]
    uuid: conjure_object::Uuid,
    #[builder(default, into)]
    #[serde(rename = "rid", skip_serializing_if = "Option::is_none", default)]
    rid: Option<super::super::api::rids::EventRid>,
    #[builder(default, into)]
    #[serde(rename = "assetRids", skip_serializing_if = "Option::is_none", default)]
    asset_rids: Option<
        std::collections::BTreeSet<super::super::scout::rids::api::AssetRid>,
    >,
    #[builder(
        default,
        custom(
            type = impl
            Into<Option<super::super::api::Timestamp>>,
            convert = |v|v.into().map(Box::new)
        )
    )]
    #[serde(rename = "timestamp", skip_serializing_if = "Option::is_none", default)]
    timestamp: Option<Box<super::super::api::Timestamp>>,
    #[builder(
        default,
        custom(
            type = impl
            Into<Option<super::super::scout::run::api::Duration>>,
            convert = |v|v.into().map(Box::new)
        )
    )]
    #[serde(rename = "duration", skip_serializing_if = "Option::is_none", default)]
    duration: Option<Box<super::super::scout::run::api::Duration>>,
    #[builder(default, into)]
    #[serde(rename = "name", skip_serializing_if = "Option::is_none", default)]
    name: Option<String>,
    #[builder(default, into)]
    #[serde(rename = "description", skip_serializing_if = "Option::is_none", default)]
    description: Option<String>,
    #[builder(default, into)]
    #[serde(rename = "type", skip_serializing_if = "Option::is_none", default)]
    type_: Option<super::EventType>,
    #[builder(default, into)]
    #[serde(rename = "labels", skip_serializing_if = "Option::is_none", default)]
    labels: Option<std::collections::BTreeSet<super::super::api::Label>>,
    #[builder(default, into)]
    #[serde(rename = "properties", skip_serializing_if = "Option::is_none", default)]
    properties: Option<
        std::collections::BTreeMap<
            super::super::api::PropertyName,
            super::super::api::PropertyValue,
        >,
    >,
}
impl UpdateEvent {
    /// Constructs a new instance of the type.
    #[inline]
    pub fn new(uuid: conjure_object::Uuid) -> Self {
        Self::builder().uuid(uuid).build()
    }
    #[deprecated(note = "This field is deprecated. Use the rid field instead.\n")]
    #[inline]
    pub fn uuid(&self) -> conjure_object::Uuid {
        self.uuid
    }
    /// The unique identifier for the event.
    /// This field is required if the uuid field is not provided.
    #[inline]
    pub fn rid(&self) -> Option<&super::super::api::rids::EventRid> {
        self.rid.as_ref().map(|o| &*o)
    }
    /// If provided, will replace the existing asset rids.
    /// If provided, must contain at least one asset rid.
    #[inline]
    pub fn asset_rids(
        &self,
    ) -> Option<&std::collections::BTreeSet<super::super::scout::rids::api::AssetRid>> {
        self.asset_rids.as_ref().map(|o| &*o)
    }
    #[inline]
    pub fn timestamp(&self) -> Option<&super::super::api::Timestamp> {
        self.timestamp.as_ref().map(|o| &**o)
    }
    #[inline]
    pub fn duration(&self) -> Option<&super::super::scout::run::api::Duration> {
        self.duration.as_ref().map(|o| &**o)
    }
    #[inline]
    pub fn name(&self) -> Option<&str> {
        self.name.as_ref().map(|o| &**o)
    }
    #[inline]
    pub fn description(&self) -> Option<&str> {
        self.description.as_ref().map(|o| &**o)
    }
    #[inline]
    pub fn type_(&self) -> Option<&super::EventType> {
        self.type_.as_ref().map(|o| &*o)
    }
    #[inline]
    pub fn labels(
        &self,
    ) -> Option<&std::collections::BTreeSet<super::super::api::Label>> {
        self.labels.as_ref().map(|o| &*o)
    }
    #[inline]
    pub fn properties(
        &self,
    ) -> Option<
        &std::collections::BTreeMap<
            super::super::api::PropertyName,
            super::super::api::PropertyValue,
        >,
    > {
        self.properties.as_ref().map(|o| &*o)
    }
}