Skip to main content

nominal_api/conjure/objects/scout/template/api/
update_metadata_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 UpdateMetadataRequest {
16    #[builder(default, into)]
17    #[serde(rename = "title", skip_serializing_if = "Option::is_none", default)]
18    title: Option<String>,
19    #[builder(default, into)]
20    #[serde(rename = "description", skip_serializing_if = "Option::is_none", default)]
21    description: Option<String>,
22    #[builder(default, into)]
23    #[serde(rename = "labels", skip_serializing_if = "Option::is_none", default)]
24    labels: Option<std::collections::BTreeSet<super::super::super::super::api::Label>>,
25    #[builder(default, into)]
26    #[serde(rename = "properties", skip_serializing_if = "Option::is_none", default)]
27    properties: Option<
28        std::collections::BTreeMap<
29            super::super::super::super::api::PropertyName,
30            super::super::super::super::api::PropertyValue,
31        >,
32    >,
33    #[builder(default, into)]
34    #[serde(rename = "isArchived", skip_serializing_if = "Option::is_none", default)]
35    is_archived: Option<bool>,
36    #[builder(default, into)]
37    #[serde(rename = "isPublished", skip_serializing_if = "Option::is_none", default)]
38    is_published: Option<bool>,
39    #[builder(
40        default,
41        custom(
42            type = impl
43            Into<Option<super::super::super::super::api::ThemeAwareImage>>,
44            convert = |v|v.into().map(Box::new)
45        )
46    )]
47    #[serde(rename = "previewImage", skip_serializing_if = "Option::is_none", default)]
48    preview_image: Option<Box<super::super::super::super::api::ThemeAwareImage>>,
49}
50impl UpdateMetadataRequest {
51    /// Constructs a new instance of the type.
52    #[inline]
53    pub fn new() -> Self {
54        Self::builder().build()
55    }
56    #[inline]
57    pub fn title(&self) -> Option<&str> {
58        self.title.as_ref().map(|o| &**o)
59    }
60    #[inline]
61    pub fn description(&self) -> Option<&str> {
62        self.description.as_ref().map(|o| &**o)
63    }
64    #[inline]
65    pub fn labels(
66        &self,
67    ) -> Option<&std::collections::BTreeSet<super::super::super::super::api::Label>> {
68        self.labels.as_ref().map(|o| &*o)
69    }
70    #[inline]
71    pub fn properties(
72        &self,
73    ) -> Option<
74        &std::collections::BTreeMap<
75            super::super::super::super::api::PropertyName,
76            super::super::super::super::api::PropertyValue,
77        >,
78    > {
79        self.properties.as_ref().map(|o| &*o)
80    }
81    #[inline]
82    pub fn is_archived(&self) -> Option<bool> {
83        self.is_archived.as_ref().map(|o| *o)
84    }
85    #[inline]
86    pub fn is_published(&self) -> Option<bool> {
87        self.is_published.as_ref().map(|o| *o)
88    }
89    /// Theme-aware preview image for the template. When provided, replaces the existing preview image.
90    #[inline]
91    pub fn preview_image(
92        &self,
93    ) -> Option<&super::super::super::super::api::ThemeAwareImage> {
94        self.preview_image.as_ref().map(|o| &**o)
95    }
96}