aws-sdk-quicksight 1.131.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

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

/// <p>A folder in Quick Sight.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct Folder {
    /// <p>The ID of the folder.</p>
    pub folder_id: ::std::option::Option<::std::string::String>,
    /// <p>The Amazon Resource Name (ARN) for the folder.</p>
    pub arn: ::std::option::Option<::std::string::String>,
    /// <p>A display name for the folder.</p>
    pub name: ::std::option::Option<::std::string::String>,
    /// <p>The type of folder it is.</p>
    pub folder_type: ::std::option::Option<crate::types::FolderType>,
    /// <p>An array of ancestor ARN strings for the folder.</p>
    pub folder_path: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    /// <p>The time that the folder was created.</p>
    pub created_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>The time that the folder was last updated.</p>
    pub last_updated_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>The sharing scope of the folder.</p>
    pub sharing_model: ::std::option::Option<crate::types::SharingModel>,
}
impl Folder {
    /// <p>The ID of the folder.</p>
    pub fn folder_id(&self) -> ::std::option::Option<&str> {
        self.folder_id.as_deref()
    }
    /// <p>The Amazon Resource Name (ARN) for the folder.</p>
    pub fn arn(&self) -> ::std::option::Option<&str> {
        self.arn.as_deref()
    }
    /// <p>A display name for the folder.</p>
    pub fn name(&self) -> ::std::option::Option<&str> {
        self.name.as_deref()
    }
    /// <p>The type of folder it is.</p>
    pub fn folder_type(&self) -> ::std::option::Option<&crate::types::FolderType> {
        self.folder_type.as_ref()
    }
    /// <p>An array of ancestor ARN strings for the folder.</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 `.folder_path.is_none()`.
    pub fn folder_path(&self) -> &[::std::string::String] {
        self.folder_path.as_deref().unwrap_or_default()
    }
    /// <p>The time that the folder 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 folder was last updated.</p>
    pub fn last_updated_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.last_updated_time.as_ref()
    }
    /// <p>The sharing scope of the folder.</p>
    pub fn sharing_model(&self) -> ::std::option::Option<&crate::types::SharingModel> {
        self.sharing_model.as_ref()
    }
}
impl Folder {
    /// Creates a new builder-style object to manufacture [`Folder`](crate::types::Folder).
    pub fn builder() -> crate::types::builders::FolderBuilder {
        crate::types::builders::FolderBuilder::default()
    }
}

/// A builder for [`Folder`](crate::types::Folder).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct FolderBuilder {
    pub(crate) folder_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) folder_type: ::std::option::Option<crate::types::FolderType>,
    pub(crate) folder_path: ::std::option::Option<::std::vec::Vec<::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) sharing_model: ::std::option::Option<crate::types::SharingModel>,
}
impl FolderBuilder {
    /// <p>The ID of the folder.</p>
    pub fn folder_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.folder_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ID of the folder.</p>
    pub fn set_folder_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.folder_id = input;
        self
    }
    /// <p>The ID of the folder.</p>
    pub fn get_folder_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.folder_id
    }
    /// <p>The Amazon Resource Name (ARN) for the folder.</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) for the folder.</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) for the folder.</p>
    pub fn get_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.arn
    }
    /// <p>A display name for the folder.</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>A display name for the folder.</p>
    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.name = input;
        self
    }
    /// <p>A display name for the folder.</p>
    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.name
    }
    /// <p>The type of folder it is.</p>
    pub fn folder_type(mut self, input: crate::types::FolderType) -> Self {
        self.folder_type = ::std::option::Option::Some(input);
        self
    }
    /// <p>The type of folder it is.</p>
    pub fn set_folder_type(mut self, input: ::std::option::Option<crate::types::FolderType>) -> Self {
        self.folder_type = input;
        self
    }
    /// <p>The type of folder it is.</p>
    pub fn get_folder_type(&self) -> &::std::option::Option<crate::types::FolderType> {
        &self.folder_type
    }
    /// Appends an item to `folder_path`.
    ///
    /// To override the contents of this collection use [`set_folder_path`](Self::set_folder_path).
    ///
    /// <p>An array of ancestor ARN strings for the folder.</p>
    pub fn folder_path(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        let mut v = self.folder_path.unwrap_or_default();
        v.push(input.into());
        self.folder_path = ::std::option::Option::Some(v);
        self
    }
    /// <p>An array of ancestor ARN strings for the folder.</p>
    pub fn set_folder_path(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
        self.folder_path = input;
        self
    }
    /// <p>An array of ancestor ARN strings for the folder.</p>
    pub fn get_folder_path(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
        &self.folder_path
    }
    /// <p>The time that the folder 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 folder 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 folder was created.</p>
    pub fn get_created_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.created_time
    }
    /// <p>The time that the folder 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 folder 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 folder was last updated.</p>
    pub fn get_last_updated_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.last_updated_time
    }
    /// <p>The sharing scope of the folder.</p>
    pub fn sharing_model(mut self, input: crate::types::SharingModel) -> Self {
        self.sharing_model = ::std::option::Option::Some(input);
        self
    }
    /// <p>The sharing scope of the folder.</p>
    pub fn set_sharing_model(mut self, input: ::std::option::Option<crate::types::SharingModel>) -> Self {
        self.sharing_model = input;
        self
    }
    /// <p>The sharing scope of the folder.</p>
    pub fn get_sharing_model(&self) -> &::std::option::Option<crate::types::SharingModel> {
        &self.sharing_model
    }
    /// Consumes the builder and constructs a [`Folder`](crate::types::Folder).
    pub fn build(self) -> crate::types::Folder {
        crate::types::Folder {
            folder_id: self.folder_id,
            arn: self.arn,
            name: self.name,
            folder_type: self.folder_type,
            folder_path: self.folder_path,
            created_time: self.created_time,
            last_updated_time: self.last_updated_time,
            sharing_model: self.sharing_model,
        }
    }
}