aws_sdk_qbusiness/operation/get_retriever/
_get_retriever_output.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2#[allow(missing_docs)] // documentation missing in model
3#[non_exhaustive]
4#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
5pub struct GetRetrieverOutput {
6    /// <p>The identifier of the Amazon Q Business application using the retriever.</p>
7    pub application_id: ::std::option::Option<::std::string::String>,
8    /// <p>The identifier of the retriever.</p>
9    pub retriever_id: ::std::option::Option<::std::string::String>,
10    /// <p>The Amazon Resource Name (ARN) of the IAM role associated with the retriever.</p>
11    pub retriever_arn: ::std::option::Option<::std::string::String>,
12    /// <p>The type of the retriever.</p>
13    pub r#type: ::std::option::Option<crate::types::RetrieverType>,
14    /// <p>The status of the retriever.</p>
15    pub status: ::std::option::Option<crate::types::RetrieverStatus>,
16    /// <p>The name of the retriever.</p>
17    pub display_name: ::std::option::Option<::std::string::String>,
18    /// <p>Provides information on how the retriever used for your Amazon Q Business application is configured.</p>
19    pub configuration: ::std::option::Option<crate::types::RetrieverConfiguration>,
20    /// <p>The Amazon Resource Name (ARN) of the role with the permission to access the retriever and required resources.</p>
21    pub role_arn: ::std::option::Option<::std::string::String>,
22    /// <p>The Unix timestamp when the retriever was created.</p>
23    pub created_at: ::std::option::Option<::aws_smithy_types::DateTime>,
24    /// <p>The Unix timestamp when the retriever was last updated.</p>
25    pub updated_at: ::std::option::Option<::aws_smithy_types::DateTime>,
26    _request_id: Option<String>,
27}
28impl GetRetrieverOutput {
29    /// <p>The identifier of the Amazon Q Business application using the retriever.</p>
30    pub fn application_id(&self) -> ::std::option::Option<&str> {
31        self.application_id.as_deref()
32    }
33    /// <p>The identifier of the retriever.</p>
34    pub fn retriever_id(&self) -> ::std::option::Option<&str> {
35        self.retriever_id.as_deref()
36    }
37    /// <p>The Amazon Resource Name (ARN) of the IAM role associated with the retriever.</p>
38    pub fn retriever_arn(&self) -> ::std::option::Option<&str> {
39        self.retriever_arn.as_deref()
40    }
41    /// <p>The type of the retriever.</p>
42    pub fn r#type(&self) -> ::std::option::Option<&crate::types::RetrieverType> {
43        self.r#type.as_ref()
44    }
45    /// <p>The status of the retriever.</p>
46    pub fn status(&self) -> ::std::option::Option<&crate::types::RetrieverStatus> {
47        self.status.as_ref()
48    }
49    /// <p>The name of the retriever.</p>
50    pub fn display_name(&self) -> ::std::option::Option<&str> {
51        self.display_name.as_deref()
52    }
53    /// <p>Provides information on how the retriever used for your Amazon Q Business application is configured.</p>
54    pub fn configuration(&self) -> ::std::option::Option<&crate::types::RetrieverConfiguration> {
55        self.configuration.as_ref()
56    }
57    /// <p>The Amazon Resource Name (ARN) of the role with the permission to access the retriever and required resources.</p>
58    pub fn role_arn(&self) -> ::std::option::Option<&str> {
59        self.role_arn.as_deref()
60    }
61    /// <p>The Unix timestamp when the retriever was created.</p>
62    pub fn created_at(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
63        self.created_at.as_ref()
64    }
65    /// <p>The Unix timestamp when the retriever was last updated.</p>
66    pub fn updated_at(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
67        self.updated_at.as_ref()
68    }
69}
70impl ::aws_types::request_id::RequestId for GetRetrieverOutput {
71    fn request_id(&self) -> Option<&str> {
72        self._request_id.as_deref()
73    }
74}
75impl GetRetrieverOutput {
76    /// Creates a new builder-style object to manufacture [`GetRetrieverOutput`](crate::operation::get_retriever::GetRetrieverOutput).
77    pub fn builder() -> crate::operation::get_retriever::builders::GetRetrieverOutputBuilder {
78        crate::operation::get_retriever::builders::GetRetrieverOutputBuilder::default()
79    }
80}
81
82/// A builder for [`GetRetrieverOutput`](crate::operation::get_retriever::GetRetrieverOutput).
83#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
84#[non_exhaustive]
85pub struct GetRetrieverOutputBuilder {
86    pub(crate) application_id: ::std::option::Option<::std::string::String>,
87    pub(crate) retriever_id: ::std::option::Option<::std::string::String>,
88    pub(crate) retriever_arn: ::std::option::Option<::std::string::String>,
89    pub(crate) r#type: ::std::option::Option<crate::types::RetrieverType>,
90    pub(crate) status: ::std::option::Option<crate::types::RetrieverStatus>,
91    pub(crate) display_name: ::std::option::Option<::std::string::String>,
92    pub(crate) configuration: ::std::option::Option<crate::types::RetrieverConfiguration>,
93    pub(crate) role_arn: ::std::option::Option<::std::string::String>,
94    pub(crate) created_at: ::std::option::Option<::aws_smithy_types::DateTime>,
95    pub(crate) updated_at: ::std::option::Option<::aws_smithy_types::DateTime>,
96    _request_id: Option<String>,
97}
98impl GetRetrieverOutputBuilder {
99    /// <p>The identifier of the Amazon Q Business application using the retriever.</p>
100    pub fn application_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
101        self.application_id = ::std::option::Option::Some(input.into());
102        self
103    }
104    /// <p>The identifier of the Amazon Q Business application using the retriever.</p>
105    pub fn set_application_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
106        self.application_id = input;
107        self
108    }
109    /// <p>The identifier of the Amazon Q Business application using the retriever.</p>
110    pub fn get_application_id(&self) -> &::std::option::Option<::std::string::String> {
111        &self.application_id
112    }
113    /// <p>The identifier of the retriever.</p>
114    pub fn retriever_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
115        self.retriever_id = ::std::option::Option::Some(input.into());
116        self
117    }
118    /// <p>The identifier of the retriever.</p>
119    pub fn set_retriever_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
120        self.retriever_id = input;
121        self
122    }
123    /// <p>The identifier of the retriever.</p>
124    pub fn get_retriever_id(&self) -> &::std::option::Option<::std::string::String> {
125        &self.retriever_id
126    }
127    /// <p>The Amazon Resource Name (ARN) of the IAM role associated with the retriever.</p>
128    pub fn retriever_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
129        self.retriever_arn = ::std::option::Option::Some(input.into());
130        self
131    }
132    /// <p>The Amazon Resource Name (ARN) of the IAM role associated with the retriever.</p>
133    pub fn set_retriever_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
134        self.retriever_arn = input;
135        self
136    }
137    /// <p>The Amazon Resource Name (ARN) of the IAM role associated with the retriever.</p>
138    pub fn get_retriever_arn(&self) -> &::std::option::Option<::std::string::String> {
139        &self.retriever_arn
140    }
141    /// <p>The type of the retriever.</p>
142    pub fn r#type(mut self, input: crate::types::RetrieverType) -> Self {
143        self.r#type = ::std::option::Option::Some(input);
144        self
145    }
146    /// <p>The type of the retriever.</p>
147    pub fn set_type(mut self, input: ::std::option::Option<crate::types::RetrieverType>) -> Self {
148        self.r#type = input;
149        self
150    }
151    /// <p>The type of the retriever.</p>
152    pub fn get_type(&self) -> &::std::option::Option<crate::types::RetrieverType> {
153        &self.r#type
154    }
155    /// <p>The status of the retriever.</p>
156    pub fn status(mut self, input: crate::types::RetrieverStatus) -> Self {
157        self.status = ::std::option::Option::Some(input);
158        self
159    }
160    /// <p>The status of the retriever.</p>
161    pub fn set_status(mut self, input: ::std::option::Option<crate::types::RetrieverStatus>) -> Self {
162        self.status = input;
163        self
164    }
165    /// <p>The status of the retriever.</p>
166    pub fn get_status(&self) -> &::std::option::Option<crate::types::RetrieverStatus> {
167        &self.status
168    }
169    /// <p>The name of the retriever.</p>
170    pub fn display_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
171        self.display_name = ::std::option::Option::Some(input.into());
172        self
173    }
174    /// <p>The name of the retriever.</p>
175    pub fn set_display_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
176        self.display_name = input;
177        self
178    }
179    /// <p>The name of the retriever.</p>
180    pub fn get_display_name(&self) -> &::std::option::Option<::std::string::String> {
181        &self.display_name
182    }
183    /// <p>Provides information on how the retriever used for your Amazon Q Business application is configured.</p>
184    pub fn configuration(mut self, input: crate::types::RetrieverConfiguration) -> Self {
185        self.configuration = ::std::option::Option::Some(input);
186        self
187    }
188    /// <p>Provides information on how the retriever used for your Amazon Q Business application is configured.</p>
189    pub fn set_configuration(mut self, input: ::std::option::Option<crate::types::RetrieverConfiguration>) -> Self {
190        self.configuration = input;
191        self
192    }
193    /// <p>Provides information on how the retriever used for your Amazon Q Business application is configured.</p>
194    pub fn get_configuration(&self) -> &::std::option::Option<crate::types::RetrieverConfiguration> {
195        &self.configuration
196    }
197    /// <p>The Amazon Resource Name (ARN) of the role with the permission to access the retriever and required resources.</p>
198    pub fn role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
199        self.role_arn = ::std::option::Option::Some(input.into());
200        self
201    }
202    /// <p>The Amazon Resource Name (ARN) of the role with the permission to access the retriever and required resources.</p>
203    pub fn set_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
204        self.role_arn = input;
205        self
206    }
207    /// <p>The Amazon Resource Name (ARN) of the role with the permission to access the retriever and required resources.</p>
208    pub fn get_role_arn(&self) -> &::std::option::Option<::std::string::String> {
209        &self.role_arn
210    }
211    /// <p>The Unix timestamp when the retriever was created.</p>
212    pub fn created_at(mut self, input: ::aws_smithy_types::DateTime) -> Self {
213        self.created_at = ::std::option::Option::Some(input);
214        self
215    }
216    /// <p>The Unix timestamp when the retriever was created.</p>
217    pub fn set_created_at(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
218        self.created_at = input;
219        self
220    }
221    /// <p>The Unix timestamp when the retriever was created.</p>
222    pub fn get_created_at(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
223        &self.created_at
224    }
225    /// <p>The Unix timestamp when the retriever was last updated.</p>
226    pub fn updated_at(mut self, input: ::aws_smithy_types::DateTime) -> Self {
227        self.updated_at = ::std::option::Option::Some(input);
228        self
229    }
230    /// <p>The Unix timestamp when the retriever was last updated.</p>
231    pub fn set_updated_at(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
232        self.updated_at = input;
233        self
234    }
235    /// <p>The Unix timestamp when the retriever was last updated.</p>
236    pub fn get_updated_at(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
237        &self.updated_at
238    }
239    pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
240        self._request_id = Some(request_id.into());
241        self
242    }
243
244    pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
245        self._request_id = request_id;
246        self
247    }
248    /// Consumes the builder and constructs a [`GetRetrieverOutput`](crate::operation::get_retriever::GetRetrieverOutput).
249    pub fn build(self) -> crate::operation::get_retriever::GetRetrieverOutput {
250        crate::operation::get_retriever::GetRetrieverOutput {
251            application_id: self.application_id,
252            retriever_id: self.retriever_id,
253            retriever_arn: self.retriever_arn,
254            r#type: self.r#type,
255            status: self.status,
256            display_name: self.display_name,
257            configuration: self.configuration,
258            role_arn: self.role_arn,
259            created_at: self.created_at,
260            updated_at: self.updated_at,
261            _request_id: self._request_id,
262        }
263    }
264}
aws_sdk_qbusiness/operation/get_retriever/_get_retriever_output.rs

aws_sdk_qbusiness/operation/get_retriever/
_get_retriever_output.rs
