nominal_api/conjure/objects/scout/template/api/
create_template_request.rs

1#[derive(
2    Debug,
3    Clone,
4    conjure_object::serde::Serialize,
5    conjure_object::serde::Deserialize,
6    conjure_object::private::DeriveWith
7)]
8#[serde(crate = "conjure_object::serde")]
9#[derive_with(PartialEq, Eq, PartialOrd, Ord, Hash)]
10#[conjure_object::private::staged_builder::staged_builder]
11#[builder(crate = conjure_object::private::staged_builder, update, inline)]
12pub struct CreateTemplateRequest {
13    #[builder(into)]
14    #[serde(rename = "title")]
15    title: String,
16    #[builder(into)]
17    #[serde(rename = "description")]
18    description: String,
19    #[builder(default, set(item(type = super::super::super::super::api::Label)))]
20    #[serde(
21        rename = "labels",
22        skip_serializing_if = "std::collections::BTreeSet::is_empty",
23        default
24    )]
25    labels: std::collections::BTreeSet<super::super::super::super::api::Label>,
26    #[builder(
27        default,
28        map(
29            key(type = super::super::super::super::api::PropertyName),
30            value(type = super::super::super::super::api::PropertyValue)
31        )
32    )]
33    #[serde(
34        rename = "properties",
35        skip_serializing_if = "std::collections::BTreeMap::is_empty",
36        default
37    )]
38    properties: std::collections::BTreeMap<
39        super::super::super::super::api::PropertyName,
40        super::super::super::super::api::PropertyValue,
41    >,
42    #[builder(default, into)]
43    #[serde(rename = "isPublished", skip_serializing_if = "Option::is_none", default)]
44    is_published: Option<bool>,
45    #[builder(default, into)]
46    #[serde(rename = "charts", skip_serializing_if = "Option::is_none", default)]
47    charts: Option<Vec<super::super::super::rids::api::VersionedVizId>>,
48    #[builder(
49        custom(
50            type = super::super::super::layout::api::WorkbookLayout,
51            convert = Box::new
52        )
53    )]
54    #[serde(rename = "layout")]
55    layout: Box<super::super::super::layout::api::WorkbookLayout>,
56    #[builder(
57        custom(
58            type = super::super::super::workbookcommon::api::WorkbookContent,
59            convert = Box::new
60        )
61    )]
62    #[serde(rename = "content")]
63    content: Box<super::super::super::workbookcommon::api::WorkbookContent>,
64    #[builder(into)]
65    #[serde(rename = "message")]
66    message: String,
67    #[builder(
68        default,
69        custom(
70            type = impl
71            Into<Option<super::super::super::super::api::ThemeAwareImage>>,
72            convert = |v|v.into().map(Box::new)
73        )
74    )]
75    #[serde(rename = "previewImage", skip_serializing_if = "Option::is_none", default)]
76    preview_image: Option<Box<super::super::super::super::api::ThemeAwareImage>>,
77    #[builder(default, into)]
78    #[serde(rename = "workspace", skip_serializing_if = "Option::is_none", default)]
79    workspace: Option<super::super::super::super::api::rids::WorkspaceRid>,
80}
81impl CreateTemplateRequest {
82    #[inline]
83    pub fn title(&self) -> &str {
84        &*self.title
85    }
86    #[inline]
87    pub fn description(&self) -> &str {
88        &*self.description
89    }
90    #[inline]
91    pub fn labels(
92        &self,
93    ) -> &std::collections::BTreeSet<super::super::super::super::api::Label> {
94        &self.labels
95    }
96    #[inline]
97    pub fn properties(
98        &self,
99    ) -> &std::collections::BTreeMap<
100        super::super::super::super::api::PropertyName,
101        super::super::super::super::api::PropertyValue,
102    > {
103        &self.properties
104    }
105    /// Default is true
106    #[inline]
107    pub fn is_published(&self) -> Option<bool> {
108        self.is_published.as_ref().map(|o| *o)
109    }
110    #[deprecated(
111        note = "charts are no longer versioned resources. They are stored in workbook content."
112    )]
113    #[inline]
114    pub fn charts(&self) -> Option<&[super::super::super::rids::api::VersionedVizId]> {
115        self.charts.as_ref().map(|o| &**o)
116    }
117    #[inline]
118    pub fn layout(&self) -> &super::super::super::layout::api::WorkbookLayout {
119        &*self.layout
120    }
121    #[inline]
122    pub fn content(&self) -> &super::super::super::workbookcommon::api::WorkbookContent {
123        &*self.content
124    }
125    #[inline]
126    pub fn message(&self) -> &str {
127        &*self.message
128    }
129    /// Theme-aware preview image for the template. Falls back to a default illustration if not provided.
130    #[inline]
131    pub fn preview_image(
132        &self,
133    ) -> Option<&super::super::super::super::api::ThemeAwareImage> {
134        self.preview_image.as_ref().map(|o| &**o)
135    }
136    /// The workspace in which to create the template. If not provided, the template will be created in the default workspace for
137    /// the user's organization, if the default workspace for the organization is configured.
138    #[inline]
139    pub fn workspace(
140        &self,
141    ) -> Option<&super::super::super::super::api::rids::WorkspaceRid> {
142        self.workspace.as_ref().map(|o| &*o)
143    }
144}
nominal_api/conjure/objects/scout/template/api/create_template_request.rs

nominal_api/conjure/objects/scout/template/api/
create_template_request.rs
