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

#[derive(
    Debug,
    Clone,
    conjure_object::serde::Serialize,
    conjure_object::serde::Deserialize,
    conjure_object::private::DeriveWith
)]
#[serde(crate = "conjure_object::serde")]
#[derive_with(PartialEq, Eq, PartialOrd, Ord, Hash)]
#[conjure_object::private::staged_builder::staged_builder]
#[builder(crate = conjure_object::private::staged_builder, update, inline)]
pub struct CreateTemplateRequest {
    #[builder(into)]
    #[serde(rename = "title")]
    title: String,
    #[builder(into)]
    #[serde(rename = "description")]
    description: String,
    #[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,
        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, into)]
    #[serde(rename = "isPublished", skip_serializing_if = "Option::is_none", default)]
    is_published: Option<bool>,
    #[builder(default, into)]
    #[serde(rename = "charts", skip_serializing_if = "Option::is_none", default)]
    charts: Option<Vec<super::super::super::rids::api::VersionedVizId>>,
    #[builder(
        custom(
            type = super::super::super::layout::api::WorkbookLayout,
            convert = Box::new
        )
    )]
    #[serde(rename = "layout")]
    layout: Box<super::super::super::layout::api::WorkbookLayout>,
    #[builder(
        custom(
            type = super::super::super::workbookcommon::api::WorkbookContent,
            convert = Box::new
        )
    )]
    #[serde(rename = "content")]
    content: Box<super::super::super::workbookcommon::api::WorkbookContent>,
    #[builder(into)]
    #[serde(rename = "message")]
    message: String,
    #[builder(
        default,
        custom(
            type = impl
            Into<Option<super::super::super::super::api::ThemeAwareImage>>,
            convert = |v|v.into().map(Box::new)
        )
    )]
    #[serde(rename = "previewImage", skip_serializing_if = "Option::is_none", default)]
    preview_image: Option<Box<super::super::super::super::api::ThemeAwareImage>>,
    #[builder(default, into)]
    #[serde(rename = "workspace", skip_serializing_if = "Option::is_none", default)]
    workspace: Option<super::super::super::super::api::rids::WorkspaceRid>,
}
impl CreateTemplateRequest {
    #[inline]
    pub fn title(&self) -> &str {
        &*self.title
    }
    #[inline]
    pub fn description(&self) -> &str {
        &*self.description
    }
    #[inline]
    pub fn labels(
        &self,
    ) -> &std::collections::BTreeSet<super::super::super::super::api::Label> {
        &self.labels
    }
    #[inline]
    pub fn properties(
        &self,
    ) -> &std::collections::BTreeMap<
        super::super::super::super::api::PropertyName,
        super::super::super::super::api::PropertyValue,
    > {
        &self.properties
    }
    /// Default is true
    #[inline]
    pub fn is_published(&self) -> Option<bool> {
        self.is_published.as_ref().map(|o| *o)
    }
    #[deprecated(
        note = "charts are no longer versioned resources. They are stored in workbook content."
    )]
    #[inline]
    pub fn charts(&self) -> Option<&[super::super::super::rids::api::VersionedVizId]> {
        self.charts.as_ref().map(|o| &**o)
    }
    #[inline]
    pub fn layout(&self) -> &super::super::super::layout::api::WorkbookLayout {
        &*self.layout
    }
    #[inline]
    pub fn content(&self) -> &super::super::super::workbookcommon::api::WorkbookContent {
        &*self.content
    }
    #[inline]
    pub fn message(&self) -> &str {
        &*self.message
    }
    /// Theme-aware preview image for the template. Falls back to a default illustration if not provided.
    #[inline]
    pub fn preview_image(
        &self,
    ) -> Option<&super::super::super::super::api::ThemeAwareImage> {
        self.preview_image.as_ref().map(|o| &**o)
    }
    /// The workspace in which to create the template. If not provided, the template will be created in the default workspace for
    /// the user's organization, if the default workspace for the organization is configured.
    #[inline]
    pub fn workspace(
        &self,
    ) -> Option<&super::super::super::super::api::rids::WorkspaceRid> {
        self.workspace.as_ref().map(|o| &*o)
    }
}