Skip to main content

aws_sdk_location/operation/update_key/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::update_key::_update_key_output::UpdateKeyOutputBuilder;
3
4pub use crate::operation::update_key::_update_key_input::UpdateKeyInputBuilder;
5
6impl crate::operation::update_key::builders::UpdateKeyInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::update_key::UpdateKeyOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::update_key::UpdateKeyError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.update_key();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `UpdateKey`.
24///
25/// <p>Updates the specified properties of a given API key resource.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct UpdateKeyFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::update_key::builders::UpdateKeyInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl crate::client::customize::internal::CustomizableSend<crate::operation::update_key::UpdateKeyOutput, crate::operation::update_key::UpdateKeyError>
33    for UpdateKeyFluentBuilder
34{
35    fn send(
36        self,
37        config_override: crate::config::Builder,
38    ) -> crate::client::customize::internal::BoxFuture<
39        crate::client::customize::internal::SendResult<crate::operation::update_key::UpdateKeyOutput, crate::operation::update_key::UpdateKeyError>,
40    > {
41        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
42    }
43}
44impl UpdateKeyFluentBuilder {
45    /// Creates a new `UpdateKeyFluentBuilder`.
46    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
47        Self {
48            handle,
49            inner: ::std::default::Default::default(),
50            config_override: ::std::option::Option::None,
51        }
52    }
53    /// Access the UpdateKey as a reference.
54    pub fn as_input(&self) -> &crate::operation::update_key::builders::UpdateKeyInputBuilder {
55        &self.inner
56    }
57    /// Sends the request and returns the response.
58    ///
59    /// If an error occurs, an `SdkError` will be returned with additional details that
60    /// can be matched against.
61    ///
62    /// By default, any retryable failures will be retried twice. Retry behavior
63    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
64    /// set when configuring the client.
65    pub async fn send(
66        self,
67    ) -> ::std::result::Result<
68        crate::operation::update_key::UpdateKeyOutput,
69        ::aws_smithy_runtime_api::client::result::SdkError<
70            crate::operation::update_key::UpdateKeyError,
71            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
72        >,
73    > {
74        let input = self
75            .inner
76            .build()
77            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
78        let runtime_plugins = crate::operation::update_key::UpdateKey::operation_runtime_plugins(
79            self.handle.runtime_plugins.clone(),
80            &self.handle.conf,
81            self.config_override,
82        );
83        crate::operation::update_key::UpdateKey::orchestrate(&runtime_plugins, input).await
84    }
85
86    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
87    pub fn customize(
88        self,
89    ) -> crate::client::customize::CustomizableOperation<
90        crate::operation::update_key::UpdateKeyOutput,
91        crate::operation::update_key::UpdateKeyError,
92        Self,
93    > {
94        crate::client::customize::CustomizableOperation::new(self)
95    }
96    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
97        self.set_config_override(::std::option::Option::Some(config_override.into()));
98        self
99    }
100
101    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
102        self.config_override = config_override;
103        self
104    }
105    /// <p>The name of the API key resource to update.</p>
106    pub fn key_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
107        self.inner = self.inner.key_name(input.into());
108        self
109    }
110    /// <p>The name of the API key resource to update.</p>
111    pub fn set_key_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
112        self.inner = self.inner.set_key_name(input);
113        self
114    }
115    /// <p>The name of the API key resource to update.</p>
116    pub fn get_key_name(&self) -> &::std::option::Option<::std::string::String> {
117        self.inner.get_key_name()
118    }
119    /// <p>Updates the description for the API key resource.</p>
120    pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
121        self.inner = self.inner.description(input.into());
122        self
123    }
124    /// <p>Updates the description for the API key resource.</p>
125    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
126        self.inner = self.inner.set_description(input);
127        self
128    }
129    /// <p>Updates the description for the API key resource.</p>
130    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
131        self.inner.get_description()
132    }
133    /// <p>Updates the timestamp for when the API key resource will expire in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>.</p>
134    pub fn expire_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
135        self.inner = self.inner.expire_time(input);
136        self
137    }
138    /// <p>Updates the timestamp for when the API key resource will expire in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>.</p>
139    pub fn set_expire_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
140        self.inner = self.inner.set_expire_time(input);
141        self
142    }
143    /// <p>Updates the timestamp for when the API key resource will expire in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>.</p>
144    pub fn get_expire_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
145        self.inner.get_expire_time()
146    }
147    /// <p>Whether the API key should expire. Set to <code>true</code> to set the API key to have no expiration time.</p>
148    pub fn no_expiry(mut self, input: bool) -> Self {
149        self.inner = self.inner.no_expiry(input);
150        self
151    }
152    /// <p>Whether the API key should expire. Set to <code>true</code> to set the API key to have no expiration time.</p>
153    pub fn set_no_expiry(mut self, input: ::std::option::Option<bool>) -> Self {
154        self.inner = self.inner.set_no_expiry(input);
155        self
156    }
157    /// <p>Whether the API key should expire. Set to <code>true</code> to set the API key to have no expiration time.</p>
158    pub fn get_no_expiry(&self) -> &::std::option::Option<bool> {
159        self.inner.get_no_expiry()
160    }
161    /// <p>The boolean flag to be included for updating <code>ExpireTime</code> or <code>Restrictions</code> details.</p>
162    /// <p>Must be set to <code>true</code> to update an API key resource that has been used in the past 7 days.</p>
163    /// <p><code>False</code> if force update is not preferred</p>
164    /// <p>Default value: <code>False</code></p>
165    pub fn force_update(mut self, input: bool) -> Self {
166        self.inner = self.inner.force_update(input);
167        self
168    }
169    /// <p>The boolean flag to be included for updating <code>ExpireTime</code> or <code>Restrictions</code> details.</p>
170    /// <p>Must be set to <code>true</code> to update an API key resource that has been used in the past 7 days.</p>
171    /// <p><code>False</code> if force update is not preferred</p>
172    /// <p>Default value: <code>False</code></p>
173    pub fn set_force_update(mut self, input: ::std::option::Option<bool>) -> Self {
174        self.inner = self.inner.set_force_update(input);
175        self
176    }
177    /// <p>The boolean flag to be included for updating <code>ExpireTime</code> or <code>Restrictions</code> details.</p>
178    /// <p>Must be set to <code>true</code> to update an API key resource that has been used in the past 7 days.</p>
179    /// <p><code>False</code> if force update is not preferred</p>
180    /// <p>Default value: <code>False</code></p>
181    pub fn get_force_update(&self) -> &::std::option::Option<bool> {
182        self.inner.get_force_update()
183    }
184    /// <p>Updates the API key restrictions for the API key resource.</p>
185    pub fn restrictions(mut self, input: crate::types::ApiKeyRestrictions) -> Self {
186        self.inner = self.inner.restrictions(input);
187        self
188    }
189    /// <p>Updates the API key restrictions for the API key resource.</p>
190    pub fn set_restrictions(mut self, input: ::std::option::Option<crate::types::ApiKeyRestrictions>) -> Self {
191        self.inner = self.inner.set_restrictions(input);
192        self
193    }
194    /// <p>Updates the API key restrictions for the API key resource.</p>
195    pub fn get_restrictions(&self) -> &::std::option::Option<crate::types::ApiKeyRestrictions> {
196        self.inner.get_restrictions()
197    }
198}