aws_sdk_qbusiness/operation/get_plugin/
_get_plugin_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 GetPluginOutput {
6    /// <p>The identifier of the application which contains the plugin.</p>
7    pub application_id: ::std::option::Option<::std::string::String>,
8    /// <p>The identifier of the plugin.</p>
9    pub plugin_id: ::std::option::Option<::std::string::String>,
10    /// <p>The name of the plugin.</p>
11    pub display_name: ::std::option::Option<::std::string::String>,
12    /// <p>The type of the plugin.</p>
13    pub r#type: ::std::option::Option<crate::types::PluginType>,
14    /// <p>The source URL used for plugin configuration.</p>
15    pub server_url: ::std::option::Option<::std::string::String>,
16    /// <p>Authentication configuration information for an Amazon Q Business plugin.</p>
17    pub auth_configuration: ::std::option::Option<crate::types::PluginAuthConfiguration>,
18    /// <p>Configuration information required to create a custom plugin.</p>
19    pub custom_plugin_configuration: ::std::option::Option<crate::types::CustomPluginConfiguration>,
20    /// <p>The current status of a plugin. A plugin is modified asynchronously.</p>
21    pub build_status: ::std::option::Option<crate::types::PluginBuildStatus>,
22    /// <p>The Amazon Resource Name (ARN) of the role with permission to access resources needed to create the plugin.</p>
23    pub plugin_arn: ::std::option::Option<::std::string::String>,
24    /// <p>The current state of the plugin.</p>
25    pub state: ::std::option::Option<crate::types::PluginState>,
26    /// <p>The timestamp for when the plugin was created.</p>
27    pub created_at: ::std::option::Option<::aws_smithy_types::DateTime>,
28    /// <p>The timestamp for when the plugin was last updated.</p>
29    pub updated_at: ::std::option::Option<::aws_smithy_types::DateTime>,
30    _request_id: Option<String>,
31}
32impl GetPluginOutput {
33    /// <p>The identifier of the application which contains the plugin.</p>
34    pub fn application_id(&self) -> ::std::option::Option<&str> {
35        self.application_id.as_deref()
36    }
37    /// <p>The identifier of the plugin.</p>
38    pub fn plugin_id(&self) -> ::std::option::Option<&str> {
39        self.plugin_id.as_deref()
40    }
41    /// <p>The name of the plugin.</p>
42    pub fn display_name(&self) -> ::std::option::Option<&str> {
43        self.display_name.as_deref()
44    }
45    /// <p>The type of the plugin.</p>
46    pub fn r#type(&self) -> ::std::option::Option<&crate::types::PluginType> {
47        self.r#type.as_ref()
48    }
49    /// <p>The source URL used for plugin configuration.</p>
50    pub fn server_url(&self) -> ::std::option::Option<&str> {
51        self.server_url.as_deref()
52    }
53    /// <p>Authentication configuration information for an Amazon Q Business plugin.</p>
54    pub fn auth_configuration(&self) -> ::std::option::Option<&crate::types::PluginAuthConfiguration> {
55        self.auth_configuration.as_ref()
56    }
57    /// <p>Configuration information required to create a custom plugin.</p>
58    pub fn custom_plugin_configuration(&self) -> ::std::option::Option<&crate::types::CustomPluginConfiguration> {
59        self.custom_plugin_configuration.as_ref()
60    }
61    /// <p>The current status of a plugin. A plugin is modified asynchronously.</p>
62    pub fn build_status(&self) -> ::std::option::Option<&crate::types::PluginBuildStatus> {
63        self.build_status.as_ref()
64    }
65    /// <p>The Amazon Resource Name (ARN) of the role with permission to access resources needed to create the plugin.</p>
66    pub fn plugin_arn(&self) -> ::std::option::Option<&str> {
67        self.plugin_arn.as_deref()
68    }
69    /// <p>The current state of the plugin.</p>
70    pub fn state(&self) -> ::std::option::Option<&crate::types::PluginState> {
71        self.state.as_ref()
72    }
73    /// <p>The timestamp for when the plugin was created.</p>
74    pub fn created_at(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
75        self.created_at.as_ref()
76    }
77    /// <p>The timestamp for when the plugin was last updated.</p>
78    pub fn updated_at(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
79        self.updated_at.as_ref()
80    }
81}
82impl ::aws_types::request_id::RequestId for GetPluginOutput {
83    fn request_id(&self) -> Option<&str> {
84        self._request_id.as_deref()
85    }
86}
87impl GetPluginOutput {
88    /// Creates a new builder-style object to manufacture [`GetPluginOutput`](crate::operation::get_plugin::GetPluginOutput).
89    pub fn builder() -> crate::operation::get_plugin::builders::GetPluginOutputBuilder {
90        crate::operation::get_plugin::builders::GetPluginOutputBuilder::default()
91    }
92}
93
94/// A builder for [`GetPluginOutput`](crate::operation::get_plugin::GetPluginOutput).
95#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
96#[non_exhaustive]
97pub struct GetPluginOutputBuilder {
98    pub(crate) application_id: ::std::option::Option<::std::string::String>,
99    pub(crate) plugin_id: ::std::option::Option<::std::string::String>,
100    pub(crate) display_name: ::std::option::Option<::std::string::String>,
101    pub(crate) r#type: ::std::option::Option<crate::types::PluginType>,
102    pub(crate) server_url: ::std::option::Option<::std::string::String>,
103    pub(crate) auth_configuration: ::std::option::Option<crate::types::PluginAuthConfiguration>,
104    pub(crate) custom_plugin_configuration: ::std::option::Option<crate::types::CustomPluginConfiguration>,
105    pub(crate) build_status: ::std::option::Option<crate::types::PluginBuildStatus>,
106    pub(crate) plugin_arn: ::std::option::Option<::std::string::String>,
107    pub(crate) state: ::std::option::Option<crate::types::PluginState>,
108    pub(crate) created_at: ::std::option::Option<::aws_smithy_types::DateTime>,
109    pub(crate) updated_at: ::std::option::Option<::aws_smithy_types::DateTime>,
110    _request_id: Option<String>,
111}
112impl GetPluginOutputBuilder {
113    /// <p>The identifier of the application which contains the plugin.</p>
114    pub fn application_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
115        self.application_id = ::std::option::Option::Some(input.into());
116        self
117    }
118    /// <p>The identifier of the application which contains the plugin.</p>
119    pub fn set_application_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
120        self.application_id = input;
121        self
122    }
123    /// <p>The identifier of the application which contains the plugin.</p>
124    pub fn get_application_id(&self) -> &::std::option::Option<::std::string::String> {
125        &self.application_id
126    }
127    /// <p>The identifier of the plugin.</p>
128    pub fn plugin_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
129        self.plugin_id = ::std::option::Option::Some(input.into());
130        self
131    }
132    /// <p>The identifier of the plugin.</p>
133    pub fn set_plugin_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
134        self.plugin_id = input;
135        self
136    }
137    /// <p>The identifier of the plugin.</p>
138    pub fn get_plugin_id(&self) -> &::std::option::Option<::std::string::String> {
139        &self.plugin_id
140    }
141    /// <p>The name of the plugin.</p>
142    pub fn display_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
143        self.display_name = ::std::option::Option::Some(input.into());
144        self
145    }
146    /// <p>The name of the plugin.</p>
147    pub fn set_display_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
148        self.display_name = input;
149        self
150    }
151    /// <p>The name of the plugin.</p>
152    pub fn get_display_name(&self) -> &::std::option::Option<::std::string::String> {
153        &self.display_name
154    }
155    /// <p>The type of the plugin.</p>
156    pub fn r#type(mut self, input: crate::types::PluginType) -> Self {
157        self.r#type = ::std::option::Option::Some(input);
158        self
159    }
160    /// <p>The type of the plugin.</p>
161    pub fn set_type(mut self, input: ::std::option::Option<crate::types::PluginType>) -> Self {
162        self.r#type = input;
163        self
164    }
165    /// <p>The type of the plugin.</p>
166    pub fn get_type(&self) -> &::std::option::Option<crate::types::PluginType> {
167        &self.r#type
168    }
169    /// <p>The source URL used for plugin configuration.</p>
170    pub fn server_url(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
171        self.server_url = ::std::option::Option::Some(input.into());
172        self
173    }
174    /// <p>The source URL used for plugin configuration.</p>
175    pub fn set_server_url(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
176        self.server_url = input;
177        self
178    }
179    /// <p>The source URL used for plugin configuration.</p>
180    pub fn get_server_url(&self) -> &::std::option::Option<::std::string::String> {
181        &self.server_url
182    }
183    /// <p>Authentication configuration information for an Amazon Q Business plugin.</p>
184    pub fn auth_configuration(mut self, input: crate::types::PluginAuthConfiguration) -> Self {
185        self.auth_configuration = ::std::option::Option::Some(input);
186        self
187    }
188    /// <p>Authentication configuration information for an Amazon Q Business plugin.</p>
189    pub fn set_auth_configuration(mut self, input: ::std::option::Option<crate::types::PluginAuthConfiguration>) -> Self {
190        self.auth_configuration = input;
191        self
192    }
193    /// <p>Authentication configuration information for an Amazon Q Business plugin.</p>
194    pub fn get_auth_configuration(&self) -> &::std::option::Option<crate::types::PluginAuthConfiguration> {
195        &self.auth_configuration
196    }
197    /// <p>Configuration information required to create a custom plugin.</p>
198    pub fn custom_plugin_configuration(mut self, input: crate::types::CustomPluginConfiguration) -> Self {
199        self.custom_plugin_configuration = ::std::option::Option::Some(input);
200        self
201    }
202    /// <p>Configuration information required to create a custom plugin.</p>
203    pub fn set_custom_plugin_configuration(mut self, input: ::std::option::Option<crate::types::CustomPluginConfiguration>) -> Self {
204        self.custom_plugin_configuration = input;
205        self
206    }
207    /// <p>Configuration information required to create a custom plugin.</p>
208    pub fn get_custom_plugin_configuration(&self) -> &::std::option::Option<crate::types::CustomPluginConfiguration> {
209        &self.custom_plugin_configuration
210    }
211    /// <p>The current status of a plugin. A plugin is modified asynchronously.</p>
212    pub fn build_status(mut self, input: crate::types::PluginBuildStatus) -> Self {
213        self.build_status = ::std::option::Option::Some(input);
214        self
215    }
216    /// <p>The current status of a plugin. A plugin is modified asynchronously.</p>
217    pub fn set_build_status(mut self, input: ::std::option::Option<crate::types::PluginBuildStatus>) -> Self {
218        self.build_status = input;
219        self
220    }
221    /// <p>The current status of a plugin. A plugin is modified asynchronously.</p>
222    pub fn get_build_status(&self) -> &::std::option::Option<crate::types::PluginBuildStatus> {
223        &self.build_status
224    }
225    /// <p>The Amazon Resource Name (ARN) of the role with permission to access resources needed to create the plugin.</p>
226    pub fn plugin_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
227        self.plugin_arn = ::std::option::Option::Some(input.into());
228        self
229    }
230    /// <p>The Amazon Resource Name (ARN) of the role with permission to access resources needed to create the plugin.</p>
231    pub fn set_plugin_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
232        self.plugin_arn = input;
233        self
234    }
235    /// <p>The Amazon Resource Name (ARN) of the role with permission to access resources needed to create the plugin.</p>
236    pub fn get_plugin_arn(&self) -> &::std::option::Option<::std::string::String> {
237        &self.plugin_arn
238    }
239    /// <p>The current state of the plugin.</p>
240    pub fn state(mut self, input: crate::types::PluginState) -> Self {
241        self.state = ::std::option::Option::Some(input);
242        self
243    }
244    /// <p>The current state of the plugin.</p>
245    pub fn set_state(mut self, input: ::std::option::Option<crate::types::PluginState>) -> Self {
246        self.state = input;
247        self
248    }
249    /// <p>The current state of the plugin.</p>
250    pub fn get_state(&self) -> &::std::option::Option<crate::types::PluginState> {
251        &self.state
252    }
253    /// <p>The timestamp for when the plugin was created.</p>
254    pub fn created_at(mut self, input: ::aws_smithy_types::DateTime) -> Self {
255        self.created_at = ::std::option::Option::Some(input);
256        self
257    }
258    /// <p>The timestamp for when the plugin was created.</p>
259    pub fn set_created_at(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
260        self.created_at = input;
261        self
262    }
263    /// <p>The timestamp for when the plugin was created.</p>
264    pub fn get_created_at(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
265        &self.created_at
266    }
267    /// <p>The timestamp for when the plugin was last updated.</p>
268    pub fn updated_at(mut self, input: ::aws_smithy_types::DateTime) -> Self {
269        self.updated_at = ::std::option::Option::Some(input);
270        self
271    }
272    /// <p>The timestamp for when the plugin was last updated.</p>
273    pub fn set_updated_at(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
274        self.updated_at = input;
275        self
276    }
277    /// <p>The timestamp for when the plugin was last updated.</p>
278    pub fn get_updated_at(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
279        &self.updated_at
280    }
281    pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
282        self._request_id = Some(request_id.into());
283        self
284    }
285
286    pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
287        self._request_id = request_id;
288        self
289    }
290    /// Consumes the builder and constructs a [`GetPluginOutput`](crate::operation::get_plugin::GetPluginOutput).
291    pub fn build(self) -> crate::operation::get_plugin::GetPluginOutput {
292        crate::operation::get_plugin::GetPluginOutput {
293            application_id: self.application_id,
294            plugin_id: self.plugin_id,
295            display_name: self.display_name,
296            r#type: self.r#type,
297            server_url: self.server_url,
298            auth_configuration: self.auth_configuration,
299            custom_plugin_configuration: self.custom_plugin_configuration,
300            build_status: self.build_status,
301            plugin_arn: self.plugin_arn,
302            state: self.state,
303            created_at: self.created_at,
304            updated_at: self.updated_at,
305            _request_id: self._request_id,
306        }
307    }
308}