aws_sdk_kendra/operation/describe_index/
_describe_index_output.rs1#[allow(missing_docs)] #[non_exhaustive]
4#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
5pub struct DescribeIndexOutput {
6 pub name: ::std::option::Option<::std::string::String>,
8 pub id: ::std::option::Option<::std::string::String>,
10 pub edition: ::std::option::Option<crate::types::IndexEdition>,
12 pub role_arn: ::std::option::Option<::std::string::String>,
14 pub server_side_encryption_configuration: ::std::option::Option<crate::types::ServerSideEncryptionConfiguration>,
16 pub status: ::std::option::Option<crate::types::IndexStatus>,
18 pub description: ::std::option::Option<::std::string::String>,
20 pub created_at: ::std::option::Option<::aws_smithy_types::DateTime>,
22 pub updated_at: ::std::option::Option<::aws_smithy_types::DateTime>,
24 pub document_metadata_configurations: ::std::option::Option<::std::vec::Vec<crate::types::DocumentMetadataConfiguration>>,
26 pub index_statistics: ::std::option::Option<crate::types::IndexStatistics>,
28 pub error_message: ::std::option::Option<::std::string::String>,
30 pub capacity_units: ::std::option::Option<crate::types::CapacityUnitsConfiguration>,
32 pub user_token_configurations: ::std::option::Option<::std::vec::Vec<crate::types::UserTokenConfiguration>>,
34 pub user_context_policy: ::std::option::Option<crate::types::UserContextPolicy>,
36 pub user_group_resolution_configuration: ::std::option::Option<crate::types::UserGroupResolutionConfiguration>,
38 _request_id: Option<String>,
39}
40impl DescribeIndexOutput {
41 pub fn name(&self) -> ::std::option::Option<&str> {
43 self.name.as_deref()
44 }
45 pub fn id(&self) -> ::std::option::Option<&str> {
47 self.id.as_deref()
48 }
49 pub fn edition(&self) -> ::std::option::Option<&crate::types::IndexEdition> {
51 self.edition.as_ref()
52 }
53 pub fn role_arn(&self) -> ::std::option::Option<&str> {
55 self.role_arn.as_deref()
56 }
57 pub fn server_side_encryption_configuration(&self) -> ::std::option::Option<&crate::types::ServerSideEncryptionConfiguration> {
59 self.server_side_encryption_configuration.as_ref()
60 }
61 pub fn status(&self) -> ::std::option::Option<&crate::types::IndexStatus> {
63 self.status.as_ref()
64 }
65 pub fn description(&self) -> ::std::option::Option<&str> {
67 self.description.as_deref()
68 }
69 pub fn created_at(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
71 self.created_at.as_ref()
72 }
73 pub fn updated_at(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
75 self.updated_at.as_ref()
76 }
77 pub fn document_metadata_configurations(&self) -> &[crate::types::DocumentMetadataConfiguration] {
81 self.document_metadata_configurations.as_deref().unwrap_or_default()
82 }
83 pub fn index_statistics(&self) -> ::std::option::Option<&crate::types::IndexStatistics> {
85 self.index_statistics.as_ref()
86 }
87 pub fn error_message(&self) -> ::std::option::Option<&str> {
89 self.error_message.as_deref()
90 }
91 pub fn capacity_units(&self) -> ::std::option::Option<&crate::types::CapacityUnitsConfiguration> {
93 self.capacity_units.as_ref()
94 }
95 pub fn user_token_configurations(&self) -> &[crate::types::UserTokenConfiguration] {
99 self.user_token_configurations.as_deref().unwrap_or_default()
100 }
101 pub fn user_context_policy(&self) -> ::std::option::Option<&crate::types::UserContextPolicy> {
103 self.user_context_policy.as_ref()
104 }
105 pub fn user_group_resolution_configuration(&self) -> ::std::option::Option<&crate::types::UserGroupResolutionConfiguration> {
107 self.user_group_resolution_configuration.as_ref()
108 }
109}
110impl ::aws_types::request_id::RequestId for DescribeIndexOutput {
111 fn request_id(&self) -> Option<&str> {
112 self._request_id.as_deref()
113 }
114}
115impl DescribeIndexOutput {
116 pub fn builder() -> crate::operation::describe_index::builders::DescribeIndexOutputBuilder {
118 crate::operation::describe_index::builders::DescribeIndexOutputBuilder::default()
119 }
120}
121
122#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
124#[non_exhaustive]
125pub struct DescribeIndexOutputBuilder {
126 pub(crate) name: ::std::option::Option<::std::string::String>,
127 pub(crate) id: ::std::option::Option<::std::string::String>,
128 pub(crate) edition: ::std::option::Option<crate::types::IndexEdition>,
129 pub(crate) role_arn: ::std::option::Option<::std::string::String>,
130 pub(crate) server_side_encryption_configuration: ::std::option::Option<crate::types::ServerSideEncryptionConfiguration>,
131 pub(crate) status: ::std::option::Option<crate::types::IndexStatus>,
132 pub(crate) description: ::std::option::Option<::std::string::String>,
133 pub(crate) created_at: ::std::option::Option<::aws_smithy_types::DateTime>,
134 pub(crate) updated_at: ::std::option::Option<::aws_smithy_types::DateTime>,
135 pub(crate) document_metadata_configurations: ::std::option::Option<::std::vec::Vec<crate::types::DocumentMetadataConfiguration>>,
136 pub(crate) index_statistics: ::std::option::Option<crate::types::IndexStatistics>,
137 pub(crate) error_message: ::std::option::Option<::std::string::String>,
138 pub(crate) capacity_units: ::std::option::Option<crate::types::CapacityUnitsConfiguration>,
139 pub(crate) user_token_configurations: ::std::option::Option<::std::vec::Vec<crate::types::UserTokenConfiguration>>,
140 pub(crate) user_context_policy: ::std::option::Option<crate::types::UserContextPolicy>,
141 pub(crate) user_group_resolution_configuration: ::std::option::Option<crate::types::UserGroupResolutionConfiguration>,
142 _request_id: Option<String>,
143}
144impl DescribeIndexOutputBuilder {
145 pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
147 self.name = ::std::option::Option::Some(input.into());
148 self
149 }
150 pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
152 self.name = input;
153 self
154 }
155 pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
157 &self.name
158 }
159 pub fn id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
161 self.id = ::std::option::Option::Some(input.into());
162 self
163 }
164 pub fn set_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
166 self.id = input;
167 self
168 }
169 pub fn get_id(&self) -> &::std::option::Option<::std::string::String> {
171 &self.id
172 }
173 pub fn edition(mut self, input: crate::types::IndexEdition) -> Self {
175 self.edition = ::std::option::Option::Some(input);
176 self
177 }
178 pub fn set_edition(mut self, input: ::std::option::Option<crate::types::IndexEdition>) -> Self {
180 self.edition = input;
181 self
182 }
183 pub fn get_edition(&self) -> &::std::option::Option<crate::types::IndexEdition> {
185 &self.edition
186 }
187 pub fn role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
189 self.role_arn = ::std::option::Option::Some(input.into());
190 self
191 }
192 pub fn set_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
194 self.role_arn = input;
195 self
196 }
197 pub fn get_role_arn(&self) -> &::std::option::Option<::std::string::String> {
199 &self.role_arn
200 }
201 pub fn server_side_encryption_configuration(mut self, input: crate::types::ServerSideEncryptionConfiguration) -> Self {
203 self.server_side_encryption_configuration = ::std::option::Option::Some(input);
204 self
205 }
206 pub fn set_server_side_encryption_configuration(mut self, input: ::std::option::Option<crate::types::ServerSideEncryptionConfiguration>) -> Self {
208 self.server_side_encryption_configuration = input;
209 self
210 }
211 pub fn get_server_side_encryption_configuration(&self) -> &::std::option::Option<crate::types::ServerSideEncryptionConfiguration> {
213 &self.server_side_encryption_configuration
214 }
215 pub fn status(mut self, input: crate::types::IndexStatus) -> Self {
217 self.status = ::std::option::Option::Some(input);
218 self
219 }
220 pub fn set_status(mut self, input: ::std::option::Option<crate::types::IndexStatus>) -> Self {
222 self.status = input;
223 self
224 }
225 pub fn get_status(&self) -> &::std::option::Option<crate::types::IndexStatus> {
227 &self.status
228 }
229 pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
231 self.description = ::std::option::Option::Some(input.into());
232 self
233 }
234 pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
236 self.description = input;
237 self
238 }
239 pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
241 &self.description
242 }
243 pub fn created_at(mut self, input: ::aws_smithy_types::DateTime) -> Self {
245 self.created_at = ::std::option::Option::Some(input);
246 self
247 }
248 pub fn set_created_at(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
250 self.created_at = input;
251 self
252 }
253 pub fn get_created_at(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
255 &self.created_at
256 }
257 pub fn updated_at(mut self, input: ::aws_smithy_types::DateTime) -> Self {
259 self.updated_at = ::std::option::Option::Some(input);
260 self
261 }
262 pub fn set_updated_at(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
264 self.updated_at = input;
265 self
266 }
267 pub fn get_updated_at(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
269 &self.updated_at
270 }
271 pub fn document_metadata_configurations(mut self, input: crate::types::DocumentMetadataConfiguration) -> Self {
277 let mut v = self.document_metadata_configurations.unwrap_or_default();
278 v.push(input);
279 self.document_metadata_configurations = ::std::option::Option::Some(v);
280 self
281 }
282 pub fn set_document_metadata_configurations(
284 mut self,
285 input: ::std::option::Option<::std::vec::Vec<crate::types::DocumentMetadataConfiguration>>,
286 ) -> Self {
287 self.document_metadata_configurations = input;
288 self
289 }
290 pub fn get_document_metadata_configurations(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::DocumentMetadataConfiguration>> {
292 &self.document_metadata_configurations
293 }
294 pub fn index_statistics(mut self, input: crate::types::IndexStatistics) -> Self {
296 self.index_statistics = ::std::option::Option::Some(input);
297 self
298 }
299 pub fn set_index_statistics(mut self, input: ::std::option::Option<crate::types::IndexStatistics>) -> Self {
301 self.index_statistics = input;
302 self
303 }
304 pub fn get_index_statistics(&self) -> &::std::option::Option<crate::types::IndexStatistics> {
306 &self.index_statistics
307 }
308 pub fn error_message(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
310 self.error_message = ::std::option::Option::Some(input.into());
311 self
312 }
313 pub fn set_error_message(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
315 self.error_message = input;
316 self
317 }
318 pub fn get_error_message(&self) -> &::std::option::Option<::std::string::String> {
320 &self.error_message
321 }
322 pub fn capacity_units(mut self, input: crate::types::CapacityUnitsConfiguration) -> Self {
324 self.capacity_units = ::std::option::Option::Some(input);
325 self
326 }
327 pub fn set_capacity_units(mut self, input: ::std::option::Option<crate::types::CapacityUnitsConfiguration>) -> Self {
329 self.capacity_units = input;
330 self
331 }
332 pub fn get_capacity_units(&self) -> &::std::option::Option<crate::types::CapacityUnitsConfiguration> {
334 &self.capacity_units
335 }
336 pub fn user_token_configurations(mut self, input: crate::types::UserTokenConfiguration) -> Self {
342 let mut v = self.user_token_configurations.unwrap_or_default();
343 v.push(input);
344 self.user_token_configurations = ::std::option::Option::Some(v);
345 self
346 }
347 pub fn set_user_token_configurations(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::UserTokenConfiguration>>) -> Self {
349 self.user_token_configurations = input;
350 self
351 }
352 pub fn get_user_token_configurations(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::UserTokenConfiguration>> {
354 &self.user_token_configurations
355 }
356 pub fn user_context_policy(mut self, input: crate::types::UserContextPolicy) -> Self {
358 self.user_context_policy = ::std::option::Option::Some(input);
359 self
360 }
361 pub fn set_user_context_policy(mut self, input: ::std::option::Option<crate::types::UserContextPolicy>) -> Self {
363 self.user_context_policy = input;
364 self
365 }
366 pub fn get_user_context_policy(&self) -> &::std::option::Option<crate::types::UserContextPolicy> {
368 &self.user_context_policy
369 }
370 pub fn user_group_resolution_configuration(mut self, input: crate::types::UserGroupResolutionConfiguration) -> Self {
372 self.user_group_resolution_configuration = ::std::option::Option::Some(input);
373 self
374 }
375 pub fn set_user_group_resolution_configuration(mut self, input: ::std::option::Option<crate::types::UserGroupResolutionConfiguration>) -> Self {
377 self.user_group_resolution_configuration = input;
378 self
379 }
380 pub fn get_user_group_resolution_configuration(&self) -> &::std::option::Option<crate::types::UserGroupResolutionConfiguration> {
382 &self.user_group_resolution_configuration
383 }
384 pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
385 self._request_id = Some(request_id.into());
386 self
387 }
388
389 pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
390 self._request_id = request_id;
391 self
392 }
393 pub fn build(self) -> crate::operation::describe_index::DescribeIndexOutput {
395 crate::operation::describe_index::DescribeIndexOutput {
396 name: self.name,
397 id: self.id,
398 edition: self.edition,
399 role_arn: self.role_arn,
400 server_side_encryption_configuration: self.server_side_encryption_configuration,
401 status: self.status,
402 description: self.description,
403 created_at: self.created_at,
404 updated_at: self.updated_at,
405 document_metadata_configurations: self.document_metadata_configurations,
406 index_statistics: self.index_statistics,
407 error_message: self.error_message,
408 capacity_units: self.capacity_units,
409 user_token_configurations: self.user_token_configurations,
410 user_context_policy: self.user_context_policy,
411 user_group_resolution_configuration: self.user_group_resolution_configuration,
412 _request_id: self._request_id,
413 }
414 }
415}