aws-sdk-quicksight 1.134.0

AWS SDK for Amazon QuickSight
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.

/// <p>Metadata structure for an analysis in Quick Sight</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct Analysis {
    /// <p>The ID of the analysis.</p>
    pub analysis_id: ::std::option::Option<::std::string::String>,
    /// <p>The Amazon Resource Name (ARN) of the analysis.</p>
    pub arn: ::std::option::Option<::std::string::String>,
    /// <p>The descriptive name of the analysis.</p>
    pub name: ::std::option::Option<::std::string::String>,
    /// <p>Status associated with the analysis.</p>
    pub status: ::std::option::Option<crate::types::ResourceStatus>,
    /// <p>Errors associated with the analysis.</p>
    pub errors: ::std::option::Option<::std::vec::Vec<crate::types::AnalysisError>>,
    /// <p>The ARNs of the datasets of the analysis.</p>
    pub data_set_arns: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    /// <p>The ARN of the theme of the analysis.</p>
    pub theme_arn: ::std::option::Option<::std::string::String>,
    /// <p>The time that the analysis was created.</p>
    pub created_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>The time that the analysis was last updated.</p>
    pub last_updated_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>A list of the associated sheets with the unique identifier and name of each sheet.</p>
    pub sheets: ::std::option::Option<::std::vec::Vec<crate::types::Sheet>>,
}
impl Analysis {
    /// <p>The ID of the analysis.</p>
    pub fn analysis_id(&self) -> ::std::option::Option<&str> {
        self.analysis_id.as_deref()
    }
    /// <p>The Amazon Resource Name (ARN) of the analysis.</p>
    pub fn arn(&self) -> ::std::option::Option<&str> {
        self.arn.as_deref()
    }
    /// <p>The descriptive name of the analysis.</p>
    pub fn name(&self) -> ::std::option::Option<&str> {
        self.name.as_deref()
    }
    /// <p>Status associated with the analysis.</p>
    pub fn status(&self) -> ::std::option::Option<&crate::types::ResourceStatus> {
        self.status.as_ref()
    }
    /// <p>Errors associated with the analysis.</p>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.errors.is_none()`.
    pub fn errors(&self) -> &[crate::types::AnalysisError] {
        self.errors.as_deref().unwrap_or_default()
    }
    /// <p>The ARNs of the datasets of the analysis.</p>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.data_set_arns.is_none()`.
    pub fn data_set_arns(&self) -> &[::std::string::String] {
        self.data_set_arns.as_deref().unwrap_or_default()
    }
    /// <p>The ARN of the theme of the analysis.</p>
    pub fn theme_arn(&self) -> ::std::option::Option<&str> {
        self.theme_arn.as_deref()
    }
    /// <p>The time that the analysis was created.</p>
    pub fn created_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.created_time.as_ref()
    }
    /// <p>The time that the analysis was last updated.</p>
    pub fn last_updated_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.last_updated_time.as_ref()
    }
    /// <p>A list of the associated sheets with the unique identifier and name of each sheet.</p>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.sheets.is_none()`.
    pub fn sheets(&self) -> &[crate::types::Sheet] {
        self.sheets.as_deref().unwrap_or_default()
    }
}
impl Analysis {
    /// Creates a new builder-style object to manufacture [`Analysis`](crate::types::Analysis).
    pub fn builder() -> crate::types::builders::AnalysisBuilder {
        crate::types::builders::AnalysisBuilder::default()
    }
}

/// A builder for [`Analysis`](crate::types::Analysis).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct AnalysisBuilder {
    pub(crate) analysis_id: ::std::option::Option<::std::string::String>,
    pub(crate) arn: ::std::option::Option<::std::string::String>,
    pub(crate) name: ::std::option::Option<::std::string::String>,
    pub(crate) status: ::std::option::Option<crate::types::ResourceStatus>,
    pub(crate) errors: ::std::option::Option<::std::vec::Vec<crate::types::AnalysisError>>,
    pub(crate) data_set_arns: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    pub(crate) theme_arn: ::std::option::Option<::std::string::String>,
    pub(crate) created_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) last_updated_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) sheets: ::std::option::Option<::std::vec::Vec<crate::types::Sheet>>,
}
impl AnalysisBuilder {
    /// <p>The ID of the analysis.</p>
    pub fn analysis_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.analysis_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ID of the analysis.</p>
    pub fn set_analysis_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.analysis_id = input;
        self
    }
    /// <p>The ID of the analysis.</p>
    pub fn get_analysis_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.analysis_id
    }
    /// <p>The Amazon Resource Name (ARN) of the analysis.</p>
    pub fn arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the analysis.</p>
    pub fn set_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.arn = input;
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the analysis.</p>
    pub fn get_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.arn
    }
    /// <p>The descriptive name of the analysis.</p>
    pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The descriptive name of the analysis.</p>
    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.name = input;
        self
    }
    /// <p>The descriptive name of the analysis.</p>
    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.name
    }
    /// <p>Status associated with the analysis.</p>
    pub fn status(mut self, input: crate::types::ResourceStatus) -> Self {
        self.status = ::std::option::Option::Some(input);
        self
    }
    /// <p>Status associated with the analysis.</p>
    pub fn set_status(mut self, input: ::std::option::Option<crate::types::ResourceStatus>) -> Self {
        self.status = input;
        self
    }
    /// <p>Status associated with the analysis.</p>
    pub fn get_status(&self) -> &::std::option::Option<crate::types::ResourceStatus> {
        &self.status
    }
    /// Appends an item to `errors`.
    ///
    /// To override the contents of this collection use [`set_errors`](Self::set_errors).
    ///
    /// <p>Errors associated with the analysis.</p>
    pub fn errors(mut self, input: crate::types::AnalysisError) -> Self {
        let mut v = self.errors.unwrap_or_default();
        v.push(input);
        self.errors = ::std::option::Option::Some(v);
        self
    }
    /// <p>Errors associated with the analysis.</p>
    pub fn set_errors(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::AnalysisError>>) -> Self {
        self.errors = input;
        self
    }
    /// <p>Errors associated with the analysis.</p>
    pub fn get_errors(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::AnalysisError>> {
        &self.errors
    }
    /// Appends an item to `data_set_arns`.
    ///
    /// To override the contents of this collection use [`set_data_set_arns`](Self::set_data_set_arns).
    ///
    /// <p>The ARNs of the datasets of the analysis.</p>
    pub fn data_set_arns(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        let mut v = self.data_set_arns.unwrap_or_default();
        v.push(input.into());
        self.data_set_arns = ::std::option::Option::Some(v);
        self
    }
    /// <p>The ARNs of the datasets of the analysis.</p>
    pub fn set_data_set_arns(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
        self.data_set_arns = input;
        self
    }
    /// <p>The ARNs of the datasets of the analysis.</p>
    pub fn get_data_set_arns(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
        &self.data_set_arns
    }
    /// <p>The ARN of the theme of the analysis.</p>
    pub fn theme_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.theme_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ARN of the theme of the analysis.</p>
    pub fn set_theme_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.theme_arn = input;
        self
    }
    /// <p>The ARN of the theme of the analysis.</p>
    pub fn get_theme_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.theme_arn
    }
    /// <p>The time that the analysis was created.</p>
    pub fn created_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.created_time = ::std::option::Option::Some(input);
        self
    }
    /// <p>The time that the analysis was created.</p>
    pub fn set_created_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.created_time = input;
        self
    }
    /// <p>The time that the analysis was created.</p>
    pub fn get_created_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.created_time
    }
    /// <p>The time that the analysis was last updated.</p>
    pub fn last_updated_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.last_updated_time = ::std::option::Option::Some(input);
        self
    }
    /// <p>The time that the analysis was last updated.</p>
    pub fn set_last_updated_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.last_updated_time = input;
        self
    }
    /// <p>The time that the analysis was last updated.</p>
    pub fn get_last_updated_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.last_updated_time
    }
    /// Appends an item to `sheets`.
    ///
    /// To override the contents of this collection use [`set_sheets`](Self::set_sheets).
    ///
    /// <p>A list of the associated sheets with the unique identifier and name of each sheet.</p>
    pub fn sheets(mut self, input: crate::types::Sheet) -> Self {
        let mut v = self.sheets.unwrap_or_default();
        v.push(input);
        self.sheets = ::std::option::Option::Some(v);
        self
    }
    /// <p>A list of the associated sheets with the unique identifier and name of each sheet.</p>
    pub fn set_sheets(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Sheet>>) -> Self {
        self.sheets = input;
        self
    }
    /// <p>A list of the associated sheets with the unique identifier and name of each sheet.</p>
    pub fn get_sheets(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Sheet>> {
        &self.sheets
    }
    /// Consumes the builder and constructs a [`Analysis`](crate::types::Analysis).
    pub fn build(self) -> crate::types::Analysis {
        crate::types::Analysis {
            analysis_id: self.analysis_id,
            arn: self.arn,
            name: self.name,
            status: self.status,
            errors: self.errors,
            data_set_arns: self.data_set_arns,
            theme_arn: self.theme_arn,
            created_time: self.created_time,
            last_updated_time: self.last_updated_time,
            sheets: self.sheets,
        }
    }
}