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
// 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, ::std::fmt::Debug)]
pub struct DescribeFaqOutput {
/// <p>The identifier of the FAQ.</p>
pub id: ::std::option::Option<::std::string::String>,
/// <p>The identifier of the index for the FAQ.</p>
pub index_id: ::std::option::Option<::std::string::String>,
/// <p>The name that you gave the FAQ when it was created.</p>
pub name: ::std::option::Option<::std::string::String>,
/// <p>The description of the FAQ that you provided when it was created.</p>
pub description: ::std::option::Option<::std::string::String>,
/// <p>The Unix timestamp when the FAQ was created.</p>
pub created_at: ::std::option::Option<::aws_smithy_types::DateTime>,
/// <p>The Unix timestamp when the FAQ was last updated.</p>
pub updated_at: ::std::option::Option<::aws_smithy_types::DateTime>,
/// <p>Information required to find a specific file in an Amazon S3 bucket.</p>
pub s3_path: ::std::option::Option<crate::types::S3Path>,
/// <p>The status of the FAQ. It is ready to use when the status is <code>ACTIVE</code>.</p>
pub status: ::std::option::Option<crate::types::FaqStatus>,
/// <p>The Amazon Resource Name (ARN) of the IAM role that provides access to the S3 bucket containing the FAQ file.</p>
pub role_arn: ::std::option::Option<::std::string::String>,
/// <p>If the <code>Status</code> field is <code>FAILED</code>, the <code>ErrorMessage</code> field contains the reason why the FAQ failed.</p>
pub error_message: ::std::option::Option<::std::string::String>,
/// <p>The file format used for the FAQ file.</p>
pub file_format: ::std::option::Option<crate::types::FaqFileFormat>,
/// <p>The code for a language. This shows a supported language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html">Adding documents in languages other than English</a>.</p>
pub language_code: ::std::option::Option<::std::string::String>,
_request_id: Option<String>,
}
impl DescribeFaqOutput {
/// <p>The identifier of the FAQ.</p>
pub fn id(&self) -> ::std::option::Option<&str> {
self.id.as_deref()
}
/// <p>The identifier of the index for the FAQ.</p>
pub fn index_id(&self) -> ::std::option::Option<&str> {
self.index_id.as_deref()
}
/// <p>The name that you gave the FAQ when it was created.</p>
pub fn name(&self) -> ::std::option::Option<&str> {
self.name.as_deref()
}
/// <p>The description of the FAQ that you provided when it was created.</p>
pub fn description(&self) -> ::std::option::Option<&str> {
self.description.as_deref()
}
/// <p>The Unix timestamp when the FAQ was created.</p>
pub fn created_at(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
self.created_at.as_ref()
}
/// <p>The Unix timestamp when the FAQ was last updated.</p>
pub fn updated_at(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
self.updated_at.as_ref()
}
/// <p>Information required to find a specific file in an Amazon S3 bucket.</p>
pub fn s3_path(&self) -> ::std::option::Option<&crate::types::S3Path> {
self.s3_path.as_ref()
}
/// <p>The status of the FAQ. It is ready to use when the status is <code>ACTIVE</code>.</p>
pub fn status(&self) -> ::std::option::Option<&crate::types::FaqStatus> {
self.status.as_ref()
}
/// <p>The Amazon Resource Name (ARN) of the IAM role that provides access to the S3 bucket containing the FAQ file.</p>
pub fn role_arn(&self) -> ::std::option::Option<&str> {
self.role_arn.as_deref()
}
/// <p>If the <code>Status</code> field is <code>FAILED</code>, the <code>ErrorMessage</code> field contains the reason why the FAQ failed.</p>
pub fn error_message(&self) -> ::std::option::Option<&str> {
self.error_message.as_deref()
}
/// <p>The file format used for the FAQ file.</p>
pub fn file_format(&self) -> ::std::option::Option<&crate::types::FaqFileFormat> {
self.file_format.as_ref()
}
/// <p>The code for a language. This shows a supported language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html">Adding documents in languages other than English</a>.</p>
pub fn language_code(&self) -> ::std::option::Option<&str> {
self.language_code.as_deref()
}
}
impl ::aws_types::request_id::RequestId for DescribeFaqOutput {
fn request_id(&self) -> Option<&str> {
self._request_id.as_deref()
}
}
impl DescribeFaqOutput {
/// Creates a new builder-style object to manufacture [`DescribeFaqOutput`](crate::operation::describe_faq::DescribeFaqOutput).
pub fn builder() -> crate::operation::describe_faq::builders::DescribeFaqOutputBuilder {
crate::operation::describe_faq::builders::DescribeFaqOutputBuilder::default()
}
}
/// A builder for [`DescribeFaqOutput`](crate::operation::describe_faq::DescribeFaqOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct DescribeFaqOutputBuilder {
pub(crate) id: ::std::option::Option<::std::string::String>,
pub(crate) index_id: ::std::option::Option<::std::string::String>,
pub(crate) name: ::std::option::Option<::std::string::String>,
pub(crate) description: ::std::option::Option<::std::string::String>,
pub(crate) created_at: ::std::option::Option<::aws_smithy_types::DateTime>,
pub(crate) updated_at: ::std::option::Option<::aws_smithy_types::DateTime>,
pub(crate) s3_path: ::std::option::Option<crate::types::S3Path>,
pub(crate) status: ::std::option::Option<crate::types::FaqStatus>,
pub(crate) role_arn: ::std::option::Option<::std::string::String>,
pub(crate) error_message: ::std::option::Option<::std::string::String>,
pub(crate) file_format: ::std::option::Option<crate::types::FaqFileFormat>,
pub(crate) language_code: ::std::option::Option<::std::string::String>,
_request_id: Option<String>,
}
impl DescribeFaqOutputBuilder {
/// <p>The identifier of the FAQ.</p>
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 identifier of the FAQ.</p>
pub fn set_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.id = input;
self
}
/// <p>The identifier of the FAQ.</p>
pub fn get_id(&self) -> &::std::option::Option<::std::string::String> {
&self.id
}
/// <p>The identifier of the index for the FAQ.</p>
pub fn index_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.index_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The identifier of the index for the FAQ.</p>
pub fn set_index_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.index_id = input;
self
}
/// <p>The identifier of the index for the FAQ.</p>
pub fn get_index_id(&self) -> &::std::option::Option<::std::string::String> {
&self.index_id
}
/// <p>The name that you gave the FAQ when it was created.</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 name that you gave the FAQ when it was created.</p>
pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.name = input;
self
}
/// <p>The name that you gave the FAQ when it was created.</p>
pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
&self.name
}
/// <p>The description of the FAQ that you provided when it was created.</p>
pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.description = ::std::option::Option::Some(input.into());
self
}
/// <p>The description of the FAQ that you provided when it was created.</p>
pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.description = input;
self
}
/// <p>The description of the FAQ that you provided when it was created.</p>
pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
&self.description
}
/// <p>The Unix timestamp when the FAQ 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 Unix timestamp when the FAQ 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 Unix timestamp when the FAQ was created.</p>
pub fn get_created_at(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
&self.created_at
}
/// <p>The Unix timestamp when the FAQ was last 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 Unix timestamp when the FAQ was last 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 Unix timestamp when the FAQ was last updated.</p>
pub fn get_updated_at(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
&self.updated_at
}
/// <p>Information required to find a specific file in an Amazon S3 bucket.</p>
pub fn s3_path(mut self, input: crate::types::S3Path) -> Self {
self.s3_path = ::std::option::Option::Some(input);
self
}
/// <p>Information required to find a specific file in an Amazon S3 bucket.</p>
pub fn set_s3_path(mut self, input: ::std::option::Option<crate::types::S3Path>) -> Self {
self.s3_path = input;
self
}
/// <p>Information required to find a specific file in an Amazon S3 bucket.</p>
pub fn get_s3_path(&self) -> &::std::option::Option<crate::types::S3Path> {
&self.s3_path
}
/// <p>The status of the FAQ. It is ready to use when the status is <code>ACTIVE</code>.</p>
pub fn status(mut self, input: crate::types::FaqStatus) -> Self {
self.status = ::std::option::Option::Some(input);
self
}
/// <p>The status of the FAQ. It is ready to use when the status is <code>ACTIVE</code>.</p>
pub fn set_status(mut self, input: ::std::option::Option<crate::types::FaqStatus>) -> Self {
self.status = input;
self
}
/// <p>The status of the FAQ. It is ready to use when the status is <code>ACTIVE</code>.</p>
pub fn get_status(&self) -> &::std::option::Option<crate::types::FaqStatus> {
&self.status
}
/// <p>The Amazon Resource Name (ARN) of the IAM role that provides access to the S3 bucket containing the FAQ file.</p>
pub fn role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.role_arn = ::std::option::Option::Some(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of the IAM role that provides access to the S3 bucket containing the FAQ file.</p>
pub fn set_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.role_arn = input;
self
}
/// <p>The Amazon Resource Name (ARN) of the IAM role that provides access to the S3 bucket containing the FAQ file.</p>
pub fn get_role_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.role_arn
}
/// <p>If the <code>Status</code> field is <code>FAILED</code>, the <code>ErrorMessage</code> field contains the reason why the FAQ failed.</p>
pub fn error_message(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.error_message = ::std::option::Option::Some(input.into());
self
}
/// <p>If the <code>Status</code> field is <code>FAILED</code>, the <code>ErrorMessage</code> field contains the reason why the FAQ failed.</p>
pub fn set_error_message(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.error_message = input;
self
}
/// <p>If the <code>Status</code> field is <code>FAILED</code>, the <code>ErrorMessage</code> field contains the reason why the FAQ failed.</p>
pub fn get_error_message(&self) -> &::std::option::Option<::std::string::String> {
&self.error_message
}
/// <p>The file format used for the FAQ file.</p>
pub fn file_format(mut self, input: crate::types::FaqFileFormat) -> Self {
self.file_format = ::std::option::Option::Some(input);
self
}
/// <p>The file format used for the FAQ file.</p>
pub fn set_file_format(mut self, input: ::std::option::Option<crate::types::FaqFileFormat>) -> Self {
self.file_format = input;
self
}
/// <p>The file format used for the FAQ file.</p>
pub fn get_file_format(&self) -> &::std::option::Option<crate::types::FaqFileFormat> {
&self.file_format
}
/// <p>The code for a language. This shows a supported language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html">Adding documents in languages other than English</a>.</p>
pub fn language_code(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.language_code = ::std::option::Option::Some(input.into());
self
}
/// <p>The code for a language. This shows a supported language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html">Adding documents in languages other than English</a>.</p>
pub fn set_language_code(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.language_code = input;
self
}
/// <p>The code for a language. This shows a supported language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html">Adding documents in languages other than English</a>.</p>
pub fn get_language_code(&self) -> &::std::option::Option<::std::string::String> {
&self.language_code
}
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 [`DescribeFaqOutput`](crate::operation::describe_faq::DescribeFaqOutput).
pub fn build(self) -> crate::operation::describe_faq::DescribeFaqOutput {
crate::operation::describe_faq::DescribeFaqOutput {
id: self.id,
index_id: self.index_id,
name: self.name,
description: self.description,
created_at: self.created_at,
updated_at: self.updated_at,
s3_path: self.s3_path,
status: self.status,
role_arn: self.role_arn,
error_message: self.error_message,
file_format: self.file_format,
language_code: self.language_code,
_request_id: self._request_id,
}
}
}