aws-sdk-iot 1.112.0

AWS SDK for AWS IoT
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::update_package_version::_update_package_version_input::UpdatePackageVersionInputBuilder;

pub use crate::operation::update_package_version::_update_package_version_output::UpdatePackageVersionOutputBuilder;

impl crate::operation::update_package_version::builders::UpdatePackageVersionInputBuilder {
    /// Sends a request with this input using the given client.
    pub async fn send_with(
        self,
        client: &crate::Client,
    ) -> ::std::result::Result<
        crate::operation::update_package_version::UpdatePackageVersionOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::update_package_version::UpdatePackageVersionError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let mut fluent_builder = client.update_package_version();
        fluent_builder.inner = self;
        fluent_builder.send().await
    }
}
/// Fluent builder constructing a request to `UpdatePackageVersion`.
///
/// <p>Updates the supported fields for a specific package version.</p>
/// <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>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct UpdatePackageVersionFluentBuilder {
    handle: ::std::sync::Arc<crate::client::Handle>,
    inner: crate::operation::update_package_version::builders::UpdatePackageVersionInputBuilder,
    config_override: ::std::option::Option<crate::config::Builder>,
}
impl
    crate::client::customize::internal::CustomizableSend<
        crate::operation::update_package_version::UpdatePackageVersionOutput,
        crate::operation::update_package_version::UpdatePackageVersionError,
    > for UpdatePackageVersionFluentBuilder
{
    fn send(
        self,
        config_override: crate::config::Builder,
    ) -> crate::client::customize::internal::BoxFuture<
        crate::client::customize::internal::SendResult<
            crate::operation::update_package_version::UpdatePackageVersionOutput,
            crate::operation::update_package_version::UpdatePackageVersionError,
        >,
    > {
        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
    }
}
impl UpdatePackageVersionFluentBuilder {
    /// Creates a new `UpdatePackageVersionFluentBuilder`.
    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
        Self {
            handle,
            inner: ::std::default::Default::default(),
            config_override: ::std::option::Option::None,
        }
    }
    /// Access the UpdatePackageVersion as a reference.
    pub fn as_input(&self) -> &crate::operation::update_package_version::builders::UpdatePackageVersionInputBuilder {
        &self.inner
    }
    /// Sends the request and returns the response.
    ///
    /// If an error occurs, an `SdkError` will be returned with additional details that
    /// can be matched against.
    ///
    /// By default, any retryable failures will be retried twice. Retry behavior
    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
    /// set when configuring the client.
    pub async fn send(
        self,
    ) -> ::std::result::Result<
        crate::operation::update_package_version::UpdatePackageVersionOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::update_package_version::UpdatePackageVersionError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let input = self
            .inner
            .build()
            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
        let runtime_plugins = crate::operation::update_package_version::UpdatePackageVersion::operation_runtime_plugins(
            self.handle.runtime_plugins.clone(),
            &self.handle.conf,
            self.config_override,
        );
        crate::operation::update_package_version::UpdatePackageVersion::orchestrate(&runtime_plugins, input).await
    }

    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
    pub fn customize(
        self,
    ) -> crate::client::customize::CustomizableOperation<
        crate::operation::update_package_version::UpdatePackageVersionOutput,
        crate::operation::update_package_version::UpdatePackageVersionError,
        Self,
    > {
        crate::client::customize::CustomizableOperation::new(self)
    }
    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
        self.set_config_override(::std::option::Option::Some(config_override.into()));
        self
    }

    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
        self.config_override = config_override;
        self
    }
    /// <p>The name of the associated software package.</p>
    pub fn package_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.package_name(input.into());
        self
    }
    /// <p>The name of the associated software package.</p>
    pub fn set_package_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_package_name(input);
        self
    }
    /// <p>The name of the associated software package.</p>
    pub fn get_package_name(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_package_name()
    }
    /// <p>The name of the target package version.</p>
    pub fn version_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.version_name(input.into());
        self
    }
    /// <p>The name of the target package version.</p>
    pub fn set_version_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_version_name(input);
        self
    }
    /// <p>The name of the target package version.</p>
    pub fn get_version_name(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_version_name()
    }
    /// <p>The package version description.</p>
    pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.description(input.into());
        self
    }
    /// <p>The package version description.</p>
    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_description(input);
        self
    }
    /// <p>The package version description.</p>
    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_description()
    }
    ///
    /// Adds a key-value pair to `attributes`.
    ///
    /// To override the contents of this collection use [`set_attributes`](Self::set_attributes).
    ///
    /// <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>
    /// <p><b>Note:</b> Attributes can be updated only when the package version is in a draft state.</p>
    /// <p>The combined size of all the attributes on a package version is limited to 3KB.</p>
    pub fn attributes(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.attributes(k.into(), v.into());
        self
    }
    /// <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>
    /// <p><b>Note:</b> Attributes can be updated only when the package version is in a draft state.</p>
    /// <p>The combined size of all the attributes on a package version is limited to 3KB.</p>
    pub fn set_attributes(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
        self.inner = self.inner.set_attributes(input);
        self
    }
    /// <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>
    /// <p><b>Note:</b> Attributes can be updated only when the package version is in a draft state.</p>
    /// <p>The combined size of all the attributes on a package version is limited to 3KB.</p>
    pub fn get_attributes(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
        self.inner.get_attributes()
    }
    /// <p>The various components that make up a software package version.</p>
    pub fn artifact(mut self, input: crate::types::PackageVersionArtifact) -> Self {
        self.inner = self.inner.artifact(input);
        self
    }
    /// <p>The various components that make up a software package version.</p>
    pub fn set_artifact(mut self, input: ::std::option::Option<crate::types::PackageVersionArtifact>) -> Self {
        self.inner = self.inner.set_artifact(input);
        self
    }
    /// <p>The various components that make up a software package version.</p>
    pub fn get_artifact(&self) -> &::std::option::Option<crate::types::PackageVersionArtifact> {
        self.inner.get_artifact()
    }
    /// <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>
    pub fn action(mut self, input: crate::types::PackageVersionAction) -> Self {
        self.inner = self.inner.action(input);
        self
    }
    /// <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>
    pub fn set_action(mut self, input: ::std::option::Option<crate::types::PackageVersionAction>) -> Self {
        self.inner = self.inner.set_action(input);
        self
    }
    /// <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>
    pub fn get_action(&self) -> &::std::option::Option<crate::types::PackageVersionAction> {
        self.inner.get_action()
    }
    /// <p>The inline job document associated with a software package version used for a quick job deployment.</p>
    pub fn recipe(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.recipe(input.into());
        self
    }
    /// <p>The inline job document associated with a software package version used for a quick job deployment.</p>
    pub fn set_recipe(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_recipe(input);
        self
    }
    /// <p>The inline job document associated with a software package version used for a quick job deployment.</p>
    pub fn get_recipe(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_recipe()
    }
    /// <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>
    pub fn client_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.client_token(input.into());
        self
    }
    /// <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>
    pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_client_token(input);
        self
    }
    /// <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>
    pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_client_token()
    }
}