aws_sdk_finspacedata/operation/get_dataset/_get_dataset_output.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2
3/// Response for the GetDataset operation
4#[non_exhaustive]
5#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
6pub struct GetDatasetOutput {
7 /// <p>The unique identifier for a Dataset.</p>
8 pub dataset_id: ::std::option::Option<::std::string::String>,
9 /// <p>The ARN identifier of the Dataset.</p>
10 pub dataset_arn: ::std::option::Option<::std::string::String>,
11 /// <p>Display title for a Dataset.</p>
12 pub dataset_title: ::std::option::Option<::std::string::String>,
13 /// <p>The format in which Dataset data is structured.</p>
14 /// <ul>
15 /// <li>
16 /// <p><code>TABULAR</code> – Data is structured in a tabular format.</p></li>
17 /// <li>
18 /// <p><code>NON_TABULAR</code> – Data is structured in a non-tabular format.</p></li>
19 /// </ul>
20 pub kind: ::std::option::Option<crate::types::DatasetKind>,
21 /// <p>A description of the Dataset.</p>
22 pub dataset_description: ::std::option::Option<::std::string::String>,
23 /// <p>The timestamp at which the Dataset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
24 pub create_time: i64,
25 /// <p>The last time that the Dataset was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
26 pub last_modified_time: i64,
27 /// <p>Definition for a schema on a tabular Dataset.</p>
28 pub schema_definition: ::std::option::Option<crate::types::SchemaUnion>,
29 /// <p>The unique resource identifier for a Dataset.</p>
30 pub alias: ::std::option::Option<::std::string::String>,
31 /// <p>Status of the Dataset creation.</p>
32 /// <ul>
33 /// <li>
34 /// <p><code>PENDING</code> – Dataset is pending creation.</p></li>
35 /// <li>
36 /// <p><code>FAILED</code> – Dataset creation has failed.</p></li>
37 /// <li>
38 /// <p><code>SUCCESS</code> – Dataset creation has succeeded.</p></li>
39 /// <li>
40 /// <p><code>RUNNING</code> – Dataset creation is running.</p></li>
41 /// </ul>
42 pub status: ::std::option::Option<crate::types::DatasetStatus>,
43 _request_id: Option<String>,
44}
45impl GetDatasetOutput {
46 /// <p>The unique identifier for a Dataset.</p>
47 pub fn dataset_id(&self) -> ::std::option::Option<&str> {
48 self.dataset_id.as_deref()
49 }
50 /// <p>The ARN identifier of the Dataset.</p>
51 pub fn dataset_arn(&self) -> ::std::option::Option<&str> {
52 self.dataset_arn.as_deref()
53 }
54 /// <p>Display title for a Dataset.</p>
55 pub fn dataset_title(&self) -> ::std::option::Option<&str> {
56 self.dataset_title.as_deref()
57 }
58 /// <p>The format in which Dataset data is structured.</p>
59 /// <ul>
60 /// <li>
61 /// <p><code>TABULAR</code> – Data is structured in a tabular format.</p></li>
62 /// <li>
63 /// <p><code>NON_TABULAR</code> – Data is structured in a non-tabular format.</p></li>
64 /// </ul>
65 pub fn kind(&self) -> ::std::option::Option<&crate::types::DatasetKind> {
66 self.kind.as_ref()
67 }
68 /// <p>A description of the Dataset.</p>
69 pub fn dataset_description(&self) -> ::std::option::Option<&str> {
70 self.dataset_description.as_deref()
71 }
72 /// <p>The timestamp at which the Dataset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
73 pub fn create_time(&self) -> i64 {
74 self.create_time
75 }
76 /// <p>The last time that the Dataset was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
77 pub fn last_modified_time(&self) -> i64 {
78 self.last_modified_time
79 }
80 /// <p>Definition for a schema on a tabular Dataset.</p>
81 pub fn schema_definition(&self) -> ::std::option::Option<&crate::types::SchemaUnion> {
82 self.schema_definition.as_ref()
83 }
84 /// <p>The unique resource identifier for a Dataset.</p>
85 pub fn alias(&self) -> ::std::option::Option<&str> {
86 self.alias.as_deref()
87 }
88 /// <p>Status of the Dataset creation.</p>
89 /// <ul>
90 /// <li>
91 /// <p><code>PENDING</code> – Dataset is pending creation.</p></li>
92 /// <li>
93 /// <p><code>FAILED</code> – Dataset creation has failed.</p></li>
94 /// <li>
95 /// <p><code>SUCCESS</code> – Dataset creation has succeeded.</p></li>
96 /// <li>
97 /// <p><code>RUNNING</code> – Dataset creation is running.</p></li>
98 /// </ul>
99 pub fn status(&self) -> ::std::option::Option<&crate::types::DatasetStatus> {
100 self.status.as_ref()
101 }
102}
103impl ::aws_types::request_id::RequestId for GetDatasetOutput {
104 fn request_id(&self) -> Option<&str> {
105 self._request_id.as_deref()
106 }
107}
108impl GetDatasetOutput {
109 /// Creates a new builder-style object to manufacture [`GetDatasetOutput`](crate::operation::get_dataset::GetDatasetOutput).
110 pub fn builder() -> crate::operation::get_dataset::builders::GetDatasetOutputBuilder {
111 crate::operation::get_dataset::builders::GetDatasetOutputBuilder::default()
112 }
113}
114
115/// A builder for [`GetDatasetOutput`](crate::operation::get_dataset::GetDatasetOutput).
116#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
117#[non_exhaustive]
118pub struct GetDatasetOutputBuilder {
119 pub(crate) dataset_id: ::std::option::Option<::std::string::String>,
120 pub(crate) dataset_arn: ::std::option::Option<::std::string::String>,
121 pub(crate) dataset_title: ::std::option::Option<::std::string::String>,
122 pub(crate) kind: ::std::option::Option<crate::types::DatasetKind>,
123 pub(crate) dataset_description: ::std::option::Option<::std::string::String>,
124 pub(crate) create_time: ::std::option::Option<i64>,
125 pub(crate) last_modified_time: ::std::option::Option<i64>,
126 pub(crate) schema_definition: ::std::option::Option<crate::types::SchemaUnion>,
127 pub(crate) alias: ::std::option::Option<::std::string::String>,
128 pub(crate) status: ::std::option::Option<crate::types::DatasetStatus>,
129 _request_id: Option<String>,
130}
131impl GetDatasetOutputBuilder {
132 /// <p>The unique identifier for a Dataset.</p>
133 pub fn dataset_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
134 self.dataset_id = ::std::option::Option::Some(input.into());
135 self
136 }
137 /// <p>The unique identifier for a Dataset.</p>
138 pub fn set_dataset_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
139 self.dataset_id = input;
140 self
141 }
142 /// <p>The unique identifier for a Dataset.</p>
143 pub fn get_dataset_id(&self) -> &::std::option::Option<::std::string::String> {
144 &self.dataset_id
145 }
146 /// <p>The ARN identifier of the Dataset.</p>
147 pub fn dataset_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
148 self.dataset_arn = ::std::option::Option::Some(input.into());
149 self
150 }
151 /// <p>The ARN identifier of the Dataset.</p>
152 pub fn set_dataset_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
153 self.dataset_arn = input;
154 self
155 }
156 /// <p>The ARN identifier of the Dataset.</p>
157 pub fn get_dataset_arn(&self) -> &::std::option::Option<::std::string::String> {
158 &self.dataset_arn
159 }
160 /// <p>Display title for a Dataset.</p>
161 pub fn dataset_title(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
162 self.dataset_title = ::std::option::Option::Some(input.into());
163 self
164 }
165 /// <p>Display title for a Dataset.</p>
166 pub fn set_dataset_title(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
167 self.dataset_title = input;
168 self
169 }
170 /// <p>Display title for a Dataset.</p>
171 pub fn get_dataset_title(&self) -> &::std::option::Option<::std::string::String> {
172 &self.dataset_title
173 }
174 /// <p>The format in which Dataset data is structured.</p>
175 /// <ul>
176 /// <li>
177 /// <p><code>TABULAR</code> – Data is structured in a tabular format.</p></li>
178 /// <li>
179 /// <p><code>NON_TABULAR</code> – Data is structured in a non-tabular format.</p></li>
180 /// </ul>
181 pub fn kind(mut self, input: crate::types::DatasetKind) -> Self {
182 self.kind = ::std::option::Option::Some(input);
183 self
184 }
185 /// <p>The format in which Dataset data is structured.</p>
186 /// <ul>
187 /// <li>
188 /// <p><code>TABULAR</code> – Data is structured in a tabular format.</p></li>
189 /// <li>
190 /// <p><code>NON_TABULAR</code> – Data is structured in a non-tabular format.</p></li>
191 /// </ul>
192 pub fn set_kind(mut self, input: ::std::option::Option<crate::types::DatasetKind>) -> Self {
193 self.kind = input;
194 self
195 }
196 /// <p>The format in which Dataset data is structured.</p>
197 /// <ul>
198 /// <li>
199 /// <p><code>TABULAR</code> – Data is structured in a tabular format.</p></li>
200 /// <li>
201 /// <p><code>NON_TABULAR</code> – Data is structured in a non-tabular format.</p></li>
202 /// </ul>
203 pub fn get_kind(&self) -> &::std::option::Option<crate::types::DatasetKind> {
204 &self.kind
205 }
206 /// <p>A description of the Dataset.</p>
207 pub fn dataset_description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
208 self.dataset_description = ::std::option::Option::Some(input.into());
209 self
210 }
211 /// <p>A description of the Dataset.</p>
212 pub fn set_dataset_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
213 self.dataset_description = input;
214 self
215 }
216 /// <p>A description of the Dataset.</p>
217 pub fn get_dataset_description(&self) -> &::std::option::Option<::std::string::String> {
218 &self.dataset_description
219 }
220 /// <p>The timestamp at which the Dataset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
221 pub fn create_time(mut self, input: i64) -> Self {
222 self.create_time = ::std::option::Option::Some(input);
223 self
224 }
225 /// <p>The timestamp at which the Dataset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
226 pub fn set_create_time(mut self, input: ::std::option::Option<i64>) -> Self {
227 self.create_time = input;
228 self
229 }
230 /// <p>The timestamp at which the Dataset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
231 pub fn get_create_time(&self) -> &::std::option::Option<i64> {
232 &self.create_time
233 }
234 /// <p>The last time that the Dataset was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
235 pub fn last_modified_time(mut self, input: i64) -> Self {
236 self.last_modified_time = ::std::option::Option::Some(input);
237 self
238 }
239 /// <p>The last time that the Dataset was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
240 pub fn set_last_modified_time(mut self, input: ::std::option::Option<i64>) -> Self {
241 self.last_modified_time = input;
242 self
243 }
244 /// <p>The last time that the Dataset was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
245 pub fn get_last_modified_time(&self) -> &::std::option::Option<i64> {
246 &self.last_modified_time
247 }
248 /// <p>Definition for a schema on a tabular Dataset.</p>
249 pub fn schema_definition(mut self, input: crate::types::SchemaUnion) -> Self {
250 self.schema_definition = ::std::option::Option::Some(input);
251 self
252 }
253 /// <p>Definition for a schema on a tabular Dataset.</p>
254 pub fn set_schema_definition(mut self, input: ::std::option::Option<crate::types::SchemaUnion>) -> Self {
255 self.schema_definition = input;
256 self
257 }
258 /// <p>Definition for a schema on a tabular Dataset.</p>
259 pub fn get_schema_definition(&self) -> &::std::option::Option<crate::types::SchemaUnion> {
260 &self.schema_definition
261 }
262 /// <p>The unique resource identifier for a Dataset.</p>
263 pub fn alias(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
264 self.alias = ::std::option::Option::Some(input.into());
265 self
266 }
267 /// <p>The unique resource identifier for a Dataset.</p>
268 pub fn set_alias(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
269 self.alias = input;
270 self
271 }
272 /// <p>The unique resource identifier for a Dataset.</p>
273 pub fn get_alias(&self) -> &::std::option::Option<::std::string::String> {
274 &self.alias
275 }
276 /// <p>Status of the Dataset creation.</p>
277 /// <ul>
278 /// <li>
279 /// <p><code>PENDING</code> – Dataset is pending creation.</p></li>
280 /// <li>
281 /// <p><code>FAILED</code> – Dataset creation has failed.</p></li>
282 /// <li>
283 /// <p><code>SUCCESS</code> – Dataset creation has succeeded.</p></li>
284 /// <li>
285 /// <p><code>RUNNING</code> – Dataset creation is running.</p></li>
286 /// </ul>
287 pub fn status(mut self, input: crate::types::DatasetStatus) -> Self {
288 self.status = ::std::option::Option::Some(input);
289 self
290 }
291 /// <p>Status of the Dataset creation.</p>
292 /// <ul>
293 /// <li>
294 /// <p><code>PENDING</code> – Dataset is pending creation.</p></li>
295 /// <li>
296 /// <p><code>FAILED</code> – Dataset creation has failed.</p></li>
297 /// <li>
298 /// <p><code>SUCCESS</code> – Dataset creation has succeeded.</p></li>
299 /// <li>
300 /// <p><code>RUNNING</code> – Dataset creation is running.</p></li>
301 /// </ul>
302 pub fn set_status(mut self, input: ::std::option::Option<crate::types::DatasetStatus>) -> Self {
303 self.status = input;
304 self
305 }
306 /// <p>Status of the Dataset creation.</p>
307 /// <ul>
308 /// <li>
309 /// <p><code>PENDING</code> – Dataset is pending creation.</p></li>
310 /// <li>
311 /// <p><code>FAILED</code> – Dataset creation has failed.</p></li>
312 /// <li>
313 /// <p><code>SUCCESS</code> – Dataset creation has succeeded.</p></li>
314 /// <li>
315 /// <p><code>RUNNING</code> – Dataset creation is running.</p></li>
316 /// </ul>
317 pub fn get_status(&self) -> &::std::option::Option<crate::types::DatasetStatus> {
318 &self.status
319 }
320 pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
321 self._request_id = Some(request_id.into());
322 self
323 }
324
325 pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
326 self._request_id = request_id;
327 self
328 }
329 /// Consumes the builder and constructs a [`GetDatasetOutput`](crate::operation::get_dataset::GetDatasetOutput).
330 pub fn build(self) -> crate::operation::get_dataset::GetDatasetOutput {
331 crate::operation::get_dataset::GetDatasetOutput {
332 dataset_id: self.dataset_id,
333 dataset_arn: self.dataset_arn,
334 dataset_title: self.dataset_title,
335 kind: self.kind,
336 dataset_description: self.dataset_description,
337 create_time: self.create_time.unwrap_or_default(),
338 last_modified_time: self.last_modified_time.unwrap_or_default(),
339 schema_definition: self.schema_definition,
340 alias: self.alias,
341 status: self.status,
342 _request_id: self._request_id,
343 }
344 }
345}