Skip to main content

nominal_api/conjure/objects/scout/asset/api/
create_asset_request.rs

1#[derive(
2    Debug,
3    Clone,
4    conjure_object::serde::Serialize,
5    conjure_object::serde::Deserialize,
6    PartialEq,
7    Eq,
8    PartialOrd,
9    Ord,
10    Hash
11)]
12#[serde(crate = "conjure_object::serde")]
13#[conjure_object::private::staged_builder::staged_builder]
14#[builder(crate = conjure_object::private::staged_builder, update, inline)]
15pub struct CreateAssetRequest {
16    #[builder(into)]
17    #[serde(rename = "title")]
18    title: String,
19    #[builder(default, into)]
20    #[serde(rename = "description", skip_serializing_if = "Option::is_none", default)]
21    description: Option<String>,
22    #[builder(
23        default,
24        map(
25            key(type = super::super::super::super::api::PropertyName),
26            value(type = super::super::super::super::api::PropertyValue)
27        )
28    )]
29    #[serde(
30        rename = "properties",
31        skip_serializing_if = "std::collections::BTreeMap::is_empty",
32        default
33    )]
34    properties: std::collections::BTreeMap<
35        super::super::super::super::api::PropertyName,
36        super::super::super::super::api::PropertyValue,
37    >,
38    #[builder(default, set(item(type = super::super::super::super::api::Label)))]
39    #[serde(
40        rename = "labels",
41        skip_serializing_if = "std::collections::BTreeSet::is_empty",
42        default
43    )]
44    labels: std::collections::BTreeSet<super::super::super::super::api::Label>,
45    #[builder(default, list(item(type = super::super::super::run::api::Link)))]
46    #[serde(rename = "links", skip_serializing_if = "Vec::is_empty", default)]
47    links: Vec<super::super::super::run::api::Link>,
48    #[builder(default, set(item(type = super::CreateAssetDataScope)))]
49    #[serde(
50        rename = "dataScopes",
51        skip_serializing_if = "std::collections::BTreeSet::is_empty",
52        default
53    )]
54    data_scopes: std::collections::BTreeSet<super::CreateAssetDataScope>,
55    #[builder(
56        default,
57        set(item(type = super::super::super::super::api::rids::AttachmentRid))
58    )]
59    #[serde(
60        rename = "attachments",
61        skip_serializing_if = "std::collections::BTreeSet::is_empty",
62        default
63    )]
64    attachments: std::collections::BTreeSet<
65        super::super::super::super::api::rids::AttachmentRid,
66    >,
67    #[builder(default, into)]
68    #[serde(rename = "type", skip_serializing_if = "Option::is_none", default)]
69    type_: Option<super::super::super::rids::api::TypeRid>,
70    #[builder(default, into)]
71    #[serde(rename = "workspace", skip_serializing_if = "Option::is_none", default)]
72    workspace: Option<super::super::super::super::api::rids::WorkspaceRid>,
73}
74impl CreateAssetRequest {
75    /// Constructs a new instance of the type.
76    #[inline]
77    pub fn new(title: impl Into<String>) -> Self {
78        Self::builder().title(title).build()
79    }
80    #[inline]
81    pub fn title(&self) -> &str {
82        &*self.title
83    }
84    #[inline]
85    pub fn description(&self) -> Option<&str> {
86        self.description.as_ref().map(|o| &**o)
87    }
88    #[inline]
89    pub fn properties(
90        &self,
91    ) -> &std::collections::BTreeMap<
92        super::super::super::super::api::PropertyName,
93        super::super::super::super::api::PropertyValue,
94    > {
95        &self.properties
96    }
97    #[inline]
98    pub fn labels(
99        &self,
100    ) -> &std::collections::BTreeSet<super::super::super::super::api::Label> {
101        &self.labels
102    }
103    #[inline]
104    pub fn links(&self) -> &[super::super::super::run::api::Link] {
105        &*self.links
106    }
107    /// The data scopes associated with the asset.
108    #[inline]
109    pub fn data_scopes(
110        &self,
111    ) -> &std::collections::BTreeSet<super::CreateAssetDataScope> {
112        &self.data_scopes
113    }
114    #[inline]
115    pub fn attachments(
116        &self,
117    ) -> &std::collections::BTreeSet<
118        super::super::super::super::api::rids::AttachmentRid,
119    > {
120        &self.attachments
121    }
122    #[inline]
123    pub fn type_(&self) -> Option<&super::super::super::rids::api::TypeRid> {
124        self.type_.as_ref().map(|o| &*o)
125    }
126    /// The workspace in which to create the asset. If not provided, the asset will be created in
127    /// the default workspace for the user's organization, if the default workspace for the
128    /// organization is configured.
129    /// All data scopes, attachments, and the optional asset type must be in the same workspace.
130    #[inline]
131    pub fn workspace(
132        &self,
133    ) -> Option<&super::super::super::super::api::rids::WorkspaceRid> {
134        self.workspace.as_ref().map(|o| &*o)
135    }
136}