aws-sdk-datazone 1.137.0

AWS SDK for Amazon DataZone
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
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq)]
pub struct GetGlossaryTermOutput {
    /// <p>The ID of the Amazon DataZone domain in which this business glossary term exists.</p>
    pub domain_id: ::std::string::String,
    /// <p>The ID of the business glossary to which this term belongs.</p>
    pub glossary_id: ::std::string::String,
    /// <p>The ID of the business glossary term.</p>
    pub id: ::std::string::String,
    /// <p>The name of the business glossary term.</p>
    pub name: ::std::string::String,
    /// <p>The short decription of the business glossary term.</p>
    pub short_description: ::std::option::Option<::std::string::String>,
    /// <p>The long description of the business glossary term.</p>
    pub long_description: ::std::option::Option<::std::string::String>,
    /// <p>The relations of the business glossary term.</p>
    pub term_relations: ::std::option::Option<crate::types::TermRelations>,
    /// <p>The status of the business glossary term.</p>
    pub status: crate::types::GlossaryTermStatus,
    /// <p>The timestamp of when the business glossary term was created.</p>
    pub created_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>The Amazon DataZone user who created the business glossary.</p>
    pub created_by: ::std::option::Option<::std::string::String>,
    /// <p>The timestamp of when the business glossary term was updated.</p>
    pub updated_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>The Amazon DataZone user who updated the business glossary term.</p>
    pub updated_by: ::std::option::Option<::std::string::String>,
    /// <p>The usage restriction of a term within a restricted glossary.</p>
    pub usage_restrictions: ::std::option::Option<::std::vec::Vec<crate::types::GlossaryUsageRestriction>>,
    _request_id: Option<String>,
}
impl GetGlossaryTermOutput {
    /// <p>The ID of the Amazon DataZone domain in which this business glossary term exists.</p>
    pub fn domain_id(&self) -> &str {
        use std::ops::Deref;
        self.domain_id.deref()
    }
    /// <p>The ID of the business glossary to which this term belongs.</p>
    pub fn glossary_id(&self) -> &str {
        use std::ops::Deref;
        self.glossary_id.deref()
    }
    /// <p>The ID of the business glossary term.</p>
    pub fn id(&self) -> &str {
        use std::ops::Deref;
        self.id.deref()
    }
    /// <p>The name of the business glossary term.</p>
    pub fn name(&self) -> &str {
        use std::ops::Deref;
        self.name.deref()
    }
    /// <p>The short decription of the business glossary term.</p>
    pub fn short_description(&self) -> ::std::option::Option<&str> {
        self.short_description.as_deref()
    }
    /// <p>The long description of the business glossary term.</p>
    pub fn long_description(&self) -> ::std::option::Option<&str> {
        self.long_description.as_deref()
    }
    /// <p>The relations of the business glossary term.</p>
    pub fn term_relations(&self) -> ::std::option::Option<&crate::types::TermRelations> {
        self.term_relations.as_ref()
    }
    /// <p>The status of the business glossary term.</p>
    pub fn status(&self) -> &crate::types::GlossaryTermStatus {
        &self.status
    }
    /// <p>The timestamp of when the business glossary term was created.</p>
    pub fn created_at(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.created_at.as_ref()
    }
    /// <p>The Amazon DataZone user who created the business glossary.</p>
    pub fn created_by(&self) -> ::std::option::Option<&str> {
        self.created_by.as_deref()
    }
    /// <p>The timestamp of when the business glossary term was updated.</p>
    pub fn updated_at(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.updated_at.as_ref()
    }
    /// <p>The Amazon DataZone user who updated the business glossary term.</p>
    pub fn updated_by(&self) -> ::std::option::Option<&str> {
        self.updated_by.as_deref()
    }
    /// <p>The usage restriction of a term within a restricted glossary.</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 `.usage_restrictions.is_none()`.
    pub fn usage_restrictions(&self) -> &[crate::types::GlossaryUsageRestriction] {
        self.usage_restrictions.as_deref().unwrap_or_default()
    }
}
impl ::std::fmt::Debug for GetGlossaryTermOutput {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("GetGlossaryTermOutput");
        formatter.field("domain_id", &self.domain_id);
        formatter.field("glossary_id", &self.glossary_id);
        formatter.field("id", &self.id);
        formatter.field("name", &"*** Sensitive Data Redacted ***");
        formatter.field("short_description", &"*** Sensitive Data Redacted ***");
        formatter.field("long_description", &"*** Sensitive Data Redacted ***");
        formatter.field("term_relations", &self.term_relations);
        formatter.field("status", &self.status);
        formatter.field("created_at", &self.created_at);
        formatter.field("created_by", &self.created_by);
        formatter.field("updated_at", &self.updated_at);
        formatter.field("updated_by", &self.updated_by);
        formatter.field("usage_restrictions", &self.usage_restrictions);
        formatter.field("_request_id", &self._request_id);
        formatter.finish()
    }
}
impl ::aws_types::request_id::RequestId for GetGlossaryTermOutput {
    fn request_id(&self) -> Option<&str> {
        self._request_id.as_deref()
    }
}
impl GetGlossaryTermOutput {
    /// Creates a new builder-style object to manufacture [`GetGlossaryTermOutput`](crate::operation::get_glossary_term::GetGlossaryTermOutput).
    pub fn builder() -> crate::operation::get_glossary_term::builders::GetGlossaryTermOutputBuilder {
        crate::operation::get_glossary_term::builders::GetGlossaryTermOutputBuilder::default()
    }
}

/// A builder for [`GetGlossaryTermOutput`](crate::operation::get_glossary_term::GetGlossaryTermOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default)]
#[non_exhaustive]
pub struct GetGlossaryTermOutputBuilder {
    pub(crate) domain_id: ::std::option::Option<::std::string::String>,
    pub(crate) glossary_id: ::std::option::Option<::std::string::String>,
    pub(crate) id: ::std::option::Option<::std::string::String>,
    pub(crate) name: ::std::option::Option<::std::string::String>,
    pub(crate) short_description: ::std::option::Option<::std::string::String>,
    pub(crate) long_description: ::std::option::Option<::std::string::String>,
    pub(crate) term_relations: ::std::option::Option<crate::types::TermRelations>,
    pub(crate) status: ::std::option::Option<crate::types::GlossaryTermStatus>,
    pub(crate) created_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) created_by: ::std::option::Option<::std::string::String>,
    pub(crate) updated_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) updated_by: ::std::option::Option<::std::string::String>,
    pub(crate) usage_restrictions: ::std::option::Option<::std::vec::Vec<crate::types::GlossaryUsageRestriction>>,
    _request_id: Option<String>,
}
impl GetGlossaryTermOutputBuilder {
    /// <p>The ID of the Amazon DataZone domain in which this business glossary term exists.</p>
    /// This field is required.
    pub fn domain_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.domain_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ID of the Amazon DataZone domain in which this business glossary term exists.</p>
    pub fn set_domain_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.domain_id = input;
        self
    }
    /// <p>The ID of the Amazon DataZone domain in which this business glossary term exists.</p>
    pub fn get_domain_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.domain_id
    }
    /// <p>The ID of the business glossary to which this term belongs.</p>
    /// This field is required.
    pub fn glossary_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.glossary_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ID of the business glossary to which this term belongs.</p>
    pub fn set_glossary_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.glossary_id = input;
        self
    }
    /// <p>The ID of the business glossary to which this term belongs.</p>
    pub fn get_glossary_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.glossary_id
    }
    /// <p>The ID of the business glossary term.</p>
    /// This field is required.
    pub fn id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ID of the business glossary term.</p>
    pub fn set_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.id = input;
        self
    }
    /// <p>The ID of the business glossary term.</p>
    pub fn get_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.id
    }
    /// <p>The name of the business glossary term.</p>
    /// This field is required.
    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 name of the business glossary term.</p>
    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.name = input;
        self
    }
    /// <p>The name of the business glossary term.</p>
    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.name
    }
    /// <p>The short decription of the business glossary term.</p>
    pub fn short_description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.short_description = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The short decription of the business glossary term.</p>
    pub fn set_short_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.short_description = input;
        self
    }
    /// <p>The short decription of the business glossary term.</p>
    pub fn get_short_description(&self) -> &::std::option::Option<::std::string::String> {
        &self.short_description
    }
    /// <p>The long description of the business glossary term.</p>
    pub fn long_description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.long_description = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The long description of the business glossary term.</p>
    pub fn set_long_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.long_description = input;
        self
    }
    /// <p>The long description of the business glossary term.</p>
    pub fn get_long_description(&self) -> &::std::option::Option<::std::string::String> {
        &self.long_description
    }
    /// <p>The relations of the business glossary term.</p>
    pub fn term_relations(mut self, input: crate::types::TermRelations) -> Self {
        self.term_relations = ::std::option::Option::Some(input);
        self
    }
    /// <p>The relations of the business glossary term.</p>
    pub fn set_term_relations(mut self, input: ::std::option::Option<crate::types::TermRelations>) -> Self {
        self.term_relations = input;
        self
    }
    /// <p>The relations of the business glossary term.</p>
    pub fn get_term_relations(&self) -> &::std::option::Option<crate::types::TermRelations> {
        &self.term_relations
    }
    /// <p>The status of the business glossary term.</p>
    /// This field is required.
    pub fn status(mut self, input: crate::types::GlossaryTermStatus) -> Self {
        self.status = ::std::option::Option::Some(input);
        self
    }
    /// <p>The status of the business glossary term.</p>
    pub fn set_status(mut self, input: ::std::option::Option<crate::types::GlossaryTermStatus>) -> Self {
        self.status = input;
        self
    }
    /// <p>The status of the business glossary term.</p>
    pub fn get_status(&self) -> &::std::option::Option<crate::types::GlossaryTermStatus> {
        &self.status
    }
    /// <p>The timestamp of when the business glossary term was created.</p>
    pub fn created_at(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.created_at = ::std::option::Option::Some(input);
        self
    }
    /// <p>The timestamp of when the business glossary term was created.</p>
    pub fn set_created_at(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.created_at = input;
        self
    }
    /// <p>The timestamp of when the business glossary term was created.</p>
    pub fn get_created_at(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.created_at
    }
    /// <p>The Amazon DataZone user who created the business glossary.</p>
    pub fn created_by(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.created_by = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The Amazon DataZone user who created the business glossary.</p>
    pub fn set_created_by(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.created_by = input;
        self
    }
    /// <p>The Amazon DataZone user who created the business glossary.</p>
    pub fn get_created_by(&self) -> &::std::option::Option<::std::string::String> {
        &self.created_by
    }
    /// <p>The timestamp of when the business glossary term was updated.</p>
    pub fn updated_at(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.updated_at = ::std::option::Option::Some(input);
        self
    }
    /// <p>The timestamp of when the business glossary term was updated.</p>
    pub fn set_updated_at(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.updated_at = input;
        self
    }
    /// <p>The timestamp of when the business glossary term was updated.</p>
    pub fn get_updated_at(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.updated_at
    }
    /// <p>The Amazon DataZone user who updated the business glossary term.</p>
    pub fn updated_by(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.updated_by = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The Amazon DataZone user who updated the business glossary term.</p>
    pub fn set_updated_by(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.updated_by = input;
        self
    }
    /// <p>The Amazon DataZone user who updated the business glossary term.</p>
    pub fn get_updated_by(&self) -> &::std::option::Option<::std::string::String> {
        &self.updated_by
    }
    /// Appends an item to `usage_restrictions`.
    ///
    /// To override the contents of this collection use [`set_usage_restrictions`](Self::set_usage_restrictions).
    ///
    /// <p>The usage restriction of a term within a restricted glossary.</p>
    pub fn usage_restrictions(mut self, input: crate::types::GlossaryUsageRestriction) -> Self {
        let mut v = self.usage_restrictions.unwrap_or_default();
        v.push(input);
        self.usage_restrictions = ::std::option::Option::Some(v);
        self
    }
    /// <p>The usage restriction of a term within a restricted glossary.</p>
    pub fn set_usage_restrictions(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::GlossaryUsageRestriction>>) -> Self {
        self.usage_restrictions = input;
        self
    }
    /// <p>The usage restriction of a term within a restricted glossary.</p>
    pub fn get_usage_restrictions(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::GlossaryUsageRestriction>> {
        &self.usage_restrictions
    }
    pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
        self._request_id = Some(request_id.into());
        self
    }

    pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
        self._request_id = request_id;
        self
    }
    /// Consumes the builder and constructs a [`GetGlossaryTermOutput`](crate::operation::get_glossary_term::GetGlossaryTermOutput).
    /// This method will fail if any of the following fields are not set:
    /// - [`domain_id`](crate::operation::get_glossary_term::builders::GetGlossaryTermOutputBuilder::domain_id)
    /// - [`glossary_id`](crate::operation::get_glossary_term::builders::GetGlossaryTermOutputBuilder::glossary_id)
    /// - [`id`](crate::operation::get_glossary_term::builders::GetGlossaryTermOutputBuilder::id)
    /// - [`name`](crate::operation::get_glossary_term::builders::GetGlossaryTermOutputBuilder::name)
    /// - [`status`](crate::operation::get_glossary_term::builders::GetGlossaryTermOutputBuilder::status)
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::get_glossary_term::GetGlossaryTermOutput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::get_glossary_term::GetGlossaryTermOutput {
            domain_id: self.domain_id.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "domain_id",
                    "domain_id was not specified but it is required when building GetGlossaryTermOutput",
                )
            })?,
            glossary_id: self.glossary_id.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "glossary_id",
                    "glossary_id was not specified but it is required when building GetGlossaryTermOutput",
                )
            })?,
            id: self.id.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "id",
                    "id was not specified but it is required when building GetGlossaryTermOutput",
                )
            })?,
            name: self.name.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "name",
                    "name was not specified but it is required when building GetGlossaryTermOutput",
                )
            })?,
            short_description: self.short_description,
            long_description: self.long_description,
            term_relations: self.term_relations,
            status: self.status.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "status",
                    "status was not specified but it is required when building GetGlossaryTermOutput",
                )
            })?,
            created_at: self.created_at,
            created_by: self.created_by,
            updated_at: self.updated_at,
            updated_by: self.updated_by,
            usage_restrictions: self.usage_restrictions,
            _request_id: self._request_id,
        })
    }
}
impl ::std::fmt::Debug for GetGlossaryTermOutputBuilder {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("GetGlossaryTermOutputBuilder");
        formatter.field("domain_id", &self.domain_id);
        formatter.field("glossary_id", &self.glossary_id);
        formatter.field("id", &self.id);
        formatter.field("name", &"*** Sensitive Data Redacted ***");
        formatter.field("short_description", &"*** Sensitive Data Redacted ***");
        formatter.field("long_description", &"*** Sensitive Data Redacted ***");
        formatter.field("term_relations", &self.term_relations);
        formatter.field("status", &self.status);
        formatter.field("created_at", &self.created_at);
        formatter.field("created_by", &self.created_by);
        formatter.field("updated_at", &self.updated_at);
        formatter.field("updated_by", &self.updated_by);
        formatter.field("usage_restrictions", &self.usage_restrictions);
        formatter.field("_request_id", &self._request_id);
        formatter.finish()
    }
}