aws_sdk_iot/operation/update_package_version/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::update_package_version::_update_package_version_output::UpdatePackageVersionOutputBuilder;
3
4pub use crate::operation::update_package_version::_update_package_version_input::UpdatePackageVersionInputBuilder;
5
6impl crate::operation::update_package_version::builders::UpdatePackageVersionInputBuilder {
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_package_version::UpdatePackageVersionOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::update_package_version::UpdatePackageVersionError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.update_package_version();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `UpdatePackageVersion`.
24///
25/// <p>Updates the supported fields for a specific package version.</p>
26/// <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UpdatePackageVersion</a> and <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">GetIndexingConfiguration</a> actions.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct UpdatePackageVersionFluentBuilder {
29    handle: ::std::sync::Arc<crate::client::Handle>,
30    inner: crate::operation::update_package_version::builders::UpdatePackageVersionInputBuilder,
31    config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34    crate::client::customize::internal::CustomizableSend<
35        crate::operation::update_package_version::UpdatePackageVersionOutput,
36        crate::operation::update_package_version::UpdatePackageVersionError,
37    > for UpdatePackageVersionFluentBuilder
38{
39    fn send(
40        self,
41        config_override: crate::config::Builder,
42    ) -> crate::client::customize::internal::BoxFuture<
43        crate::client::customize::internal::SendResult<
44            crate::operation::update_package_version::UpdatePackageVersionOutput,
45            crate::operation::update_package_version::UpdatePackageVersionError,
46        >,
47    > {
48        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49    }
50}
51impl UpdatePackageVersionFluentBuilder {
52    /// Creates a new `UpdatePackageVersionFluentBuilder`.
53    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
54        Self {
55            handle,
56            inner: ::std::default::Default::default(),
57            config_override: ::std::option::Option::None,
58        }
59    }
60    /// Access the UpdatePackageVersion as a reference.
61    pub fn as_input(&self) -> &crate::operation::update_package_version::builders::UpdatePackageVersionInputBuilder {
62        &self.inner
63    }
64    /// Sends the request and returns the response.
65    ///
66    /// If an error occurs, an `SdkError` will be returned with additional details that
67    /// can be matched against.
68    ///
69    /// By default, any retryable failures will be retried twice. Retry behavior
70    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
71    /// set when configuring the client.
72    pub async fn send(
73        self,
74    ) -> ::std::result::Result<
75        crate::operation::update_package_version::UpdatePackageVersionOutput,
76        ::aws_smithy_runtime_api::client::result::SdkError<
77            crate::operation::update_package_version::UpdatePackageVersionError,
78            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
79        >,
80    > {
81        let input = self
82            .inner
83            .build()
84            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
85        let runtime_plugins = crate::operation::update_package_version::UpdatePackageVersion::operation_runtime_plugins(
86            self.handle.runtime_plugins.clone(),
87            &self.handle.conf,
88            self.config_override,
89        );
90        crate::operation::update_package_version::UpdatePackageVersion::orchestrate(&runtime_plugins, input).await
91    }
92
93    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
94    pub fn customize(
95        self,
96    ) -> crate::client::customize::CustomizableOperation<
97        crate::operation::update_package_version::UpdatePackageVersionOutput,
98        crate::operation::update_package_version::UpdatePackageVersionError,
99        Self,
100    > {
101        crate::client::customize::CustomizableOperation::new(self)
102    }
103    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
104        self.set_config_override(::std::option::Option::Some(config_override.into()));
105        self
106    }
107
108    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
109        self.config_override = config_override;
110        self
111    }
112    /// <p>The name of the associated software package.</p>
113    pub fn package_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
114        self.inner = self.inner.package_name(input.into());
115        self
116    }
117    /// <p>The name of the associated software package.</p>
118    pub fn set_package_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
119        self.inner = self.inner.set_package_name(input);
120        self
121    }
122    /// <p>The name of the associated software package.</p>
123    pub fn get_package_name(&self) -> &::std::option::Option<::std::string::String> {
124        self.inner.get_package_name()
125    }
126    /// <p>The name of the target package version.</p>
127    pub fn version_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
128        self.inner = self.inner.version_name(input.into());
129        self
130    }
131    /// <p>The name of the target package version.</p>
132    pub fn set_version_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
133        self.inner = self.inner.set_version_name(input);
134        self
135    }
136    /// <p>The name of the target package version.</p>
137    pub fn get_version_name(&self) -> &::std::option::Option<::std::string::String> {
138        self.inner.get_version_name()
139    }
140    /// <p>The package version description.</p>
141    pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
142        self.inner = self.inner.description(input.into());
143        self
144    }
145    /// <p>The package version description.</p>
146    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
147        self.inner = self.inner.set_description(input);
148        self
149    }
150    /// <p>The package version description.</p>
151    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
152        self.inner.get_description()
153    }
154    ///
155    /// Adds a key-value pair to `attributes`.
156    ///
157    /// To override the contents of this collection use [`set_attributes`](Self::set_attributes).
158    ///
159    /// <p>Metadata that can be used to define a package version’s configuration. For example, the Amazon S3 file location, configuration options that are being sent to the device or fleet.</p>
160    /// <p><b>Note:</b> Attributes can be updated only when the package version is in a draft state.</p>
161    /// <p>The combined size of all the attributes on a package version is limited to 3KB.</p>
162    pub fn attributes(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
163        self.inner = self.inner.attributes(k.into(), v.into());
164        self
165    }
166    /// <p>Metadata that can be used to define a package version’s configuration. For example, the Amazon S3 file location, configuration options that are being sent to the device or fleet.</p>
167    /// <p><b>Note:</b> Attributes can be updated only when the package version is in a draft state.</p>
168    /// <p>The combined size of all the attributes on a package version is limited to 3KB.</p>
169    pub fn set_attributes(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
170        self.inner = self.inner.set_attributes(input);
171        self
172    }
173    /// <p>Metadata that can be used to define a package version’s configuration. For example, the Amazon S3 file location, configuration options that are being sent to the device or fleet.</p>
174    /// <p><b>Note:</b> Attributes can be updated only when the package version is in a draft state.</p>
175    /// <p>The combined size of all the attributes on a package version is limited to 3KB.</p>
176    pub fn get_attributes(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
177        self.inner.get_attributes()
178    }
179    /// <p>The various components that make up a software package version.</p>
180    pub fn artifact(mut self, input: crate::types::PackageVersionArtifact) -> Self {
181        self.inner = self.inner.artifact(input);
182        self
183    }
184    /// <p>The various components that make up a software package version.</p>
185    pub fn set_artifact(mut self, input: ::std::option::Option<crate::types::PackageVersionArtifact>) -> Self {
186        self.inner = self.inner.set_artifact(input);
187        self
188    }
189    /// <p>The various components that make up a software package version.</p>
190    pub fn get_artifact(&self) -> &::std::option::Option<crate::types::PackageVersionArtifact> {
191        self.inner.get_artifact()
192    }
193    /// <p>The status that the package version should be assigned. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle">Package version lifecycle</a>.</p>
194    pub fn action(mut self, input: crate::types::PackageVersionAction) -> Self {
195        self.inner = self.inner.action(input);
196        self
197    }
198    /// <p>The status that the package version should be assigned. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle">Package version lifecycle</a>.</p>
199    pub fn set_action(mut self, input: ::std::option::Option<crate::types::PackageVersionAction>) -> Self {
200        self.inner = self.inner.set_action(input);
201        self
202    }
203    /// <p>The status that the package version should be assigned. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle">Package version lifecycle</a>.</p>
204    pub fn get_action(&self) -> &::std::option::Option<crate::types::PackageVersionAction> {
205        self.inner.get_action()
206    }
207    /// <p>The inline job document associated with a software package version used for a quick job deployment.</p>
208    pub fn recipe(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
209        self.inner = self.inner.recipe(input.into());
210        self
211    }
212    /// <p>The inline job document associated with a software package version used for a quick job deployment.</p>
213    pub fn set_recipe(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
214        self.inner = self.inner.set_recipe(input);
215        self
216    }
217    /// <p>The inline job document associated with a software package version used for a quick job deployment.</p>
218    pub fn get_recipe(&self) -> &::std::option::Option<::std::string::String> {
219        self.inner.get_recipe()
220    }
221    /// <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
222    pub fn client_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
223        self.inner = self.inner.client_token(input.into());
224        self
225    }
226    /// <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
227    pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
228        self.inner = self.inner.set_client_token(input);
229        self
230    }
231    /// <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
232    pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
233        self.inner.get_client_token()
234    }
235}
aws_sdk_iot/operation/update_package_version/builders.rs

aws_sdk_iot/operation/update_package_version/
builders.rs
