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

#[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 CreateAssetRequest {
    #[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, set(item(type = super::CreateAssetDataScope)))]
    #[serde(
        rename = "dataScopes",
        skip_serializing_if = "std::collections::BTreeSet::is_empty",
        default
    )]
    data_scopes: std::collections::BTreeSet<super::CreateAssetDataScope>,
    #[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>,
    #[builder(default, into)]
    #[serde(rename = "workspace", skip_serializing_if = "Option::is_none", default)]
    workspace: Option<super::super::super::super::api::rids::WorkspaceRid>,
}
impl CreateAssetRequest {
    /// Constructs a new instance of the type.
    #[inline]
    pub fn new(title: impl Into<String>) -> Self {
        Self::builder().title(title).build()
    }
    #[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
    }
    #[inline]
    pub fn labels(
        &self,
    ) -> &std::collections::BTreeSet<super::super::super::super::api::Label> {
        &self.labels
    }
    #[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,
    ) -> &std::collections::BTreeSet<super::CreateAssetDataScope> {
        &self.data_scopes
    }
    #[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)
    }
    /// The workspace in which to create the asset. If not provided, the asset will be created in
    /// the default workspace for the user's organization, if the default workspace for the
    /// organization is configured.
    /// All data scopes, attachments, and the optional asset type must be in the same workspace.
    #[inline]
    pub fn workspace(
        &self,
    ) -> Option<&super::super::super::super::api::rids::WorkspaceRid> {
        self.workspace.as_ref().map(|o| &*o)
    }
}