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

#[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 Asset {
    #[serde(rename = "rid")]
    rid: super::super::super::rids::api::AssetRid,
    #[builder(into)]
    #[serde(rename = "title")]
    title: String,
    #[builder(default, into)]
    #[serde(rename = "description", skip_serializing_if = "Option::is_none", default)]
    description: Option<String>,
    #[builder(
        default,
        map(
            key(type = super::super::super::super::api::PropertyName),
            value(type = super::super::super::super::api::PropertyValue)
        )
    )]
    #[serde(
        rename = "properties",
        skip_serializing_if = "std::collections::BTreeMap::is_empty",
        default
    )]
    properties: std::collections::BTreeMap<
        super::super::super::super::api::PropertyName,
        super::super::super::super::api::PropertyValue,
    >,
    #[builder(default, set(item(type = super::super::super::super::api::Label)))]
    #[serde(
        rename = "labels",
        skip_serializing_if = "std::collections::BTreeSet::is_empty",
        default
    )]
    labels: std::collections::BTreeSet<super::super::super::super::api::Label>,
    #[builder(default, list(item(type = super::super::super::run::api::Link)))]
    #[serde(rename = "links", skip_serializing_if = "Vec::is_empty", default)]
    links: Vec<super::super::super::run::api::Link>,
    #[builder(default, list(item(type = super::DataScope)))]
    #[serde(rename = "dataScopes", skip_serializing_if = "Vec::is_empty", default)]
    data_scopes: Vec<super::DataScope>,
    #[builder(default, into)]
    #[serde(rename = "createdBy", skip_serializing_if = "Option::is_none", default)]
    created_by: Option<conjure_object::ResourceIdentifier>,
    #[serde(rename = "createdAt")]
    created_at: conjure_object::DateTime<conjure_object::Utc>,
    #[serde(rename = "updatedAt")]
    updated_at: conjure_object::DateTime<conjure_object::Utc>,
    #[builder(
        default,
        set(item(type = super::super::super::super::api::rids::AttachmentRid))
    )]
    #[serde(
        rename = "attachments",
        skip_serializing_if = "std::collections::BTreeSet::is_empty",
        default
    )]
    attachments: std::collections::BTreeSet<
        super::super::super::super::api::rids::AttachmentRid,
    >,
    #[builder(default, into)]
    #[serde(rename = "type", skip_serializing_if = "Option::is_none", default)]
    type_: Option<super::super::super::rids::api::TypeRid>,
    #[serde(rename = "isStaged")]
    is_staged: bool,
    #[serde(rename = "isArchived")]
    is_archived: bool,
}
impl Asset {
    #[inline]
    pub fn rid(&self) -> &super::super::super::rids::api::AssetRid {
        &self.rid
    }
    #[inline]
    pub fn title(&self) -> &str {
        &*self.title
    }
    #[inline]
    pub fn description(&self) -> Option<&str> {
        self.description.as_ref().map(|o| &**o)
    }
    #[inline]
    pub fn properties(
        &self,
    ) -> &std::collections::BTreeMap<
        super::super::super::super::api::PropertyName,
        super::super::super::super::api::PropertyValue,
    > {
        &self.properties
    }
    /// Labels associated with the asset. These labels do not have a time dimension.
    /// To associate labels with a range of time, create a time range on the asset with labels.
    #[inline]
    pub fn labels(
        &self,
    ) -> &std::collections::BTreeSet<super::super::super::super::api::Label> {
        &self.labels
    }
    /// Links associated with the asset. These links do not have a time dimension.
    /// To associate links with a range of time, create a time range on the asset with links.
    #[inline]
    pub fn links(&self) -> &[super::super::super::run::api::Link] {
        &*self.links
    }
    /// The data scopes associated with the asset.
    #[inline]
    pub fn data_scopes(&self) -> &[super::DataScope] {
        &*self.data_scopes
    }
    #[inline]
    pub fn created_by(&self) -> Option<&conjure_object::ResourceIdentifier> {
        self.created_by.as_ref().map(|o| &*o)
    }
    #[inline]
    pub fn created_at(&self) -> conjure_object::DateTime<conjure_object::Utc> {
        self.created_at
    }
    #[inline]
    pub fn updated_at(&self) -> conjure_object::DateTime<conjure_object::Utc> {
        self.updated_at
    }
    #[inline]
    pub fn attachments(
        &self,
    ) -> &std::collections::BTreeSet<
        super::super::super::super::api::rids::AttachmentRid,
    > {
        &self.attachments
    }
    #[inline]
    pub fn type_(&self) -> Option<&super::super::super::rids::api::TypeRid> {
        self.type_.as_ref().map(|o| &*o)
    }
    /// Auto created assets are considered staged by default.
    #[inline]
    pub fn is_staged(&self) -> bool {
        self.is_staged
    }
    #[inline]
    pub fn is_archived(&self) -> bool {
        self.is_archived
    }
}