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.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq)]
pub struct CreatePackageVersionInput {
    /// <p>The name of the associated software package.</p>
    pub package_name: ::std::option::Option<::std::string::String>,
    /// <p>The name of the new package version.</p>
    pub version_name: ::std::option::Option<::std::string::String>,
    /// <p>A summary of the package version being created. This can be used to outline the package's contents or purpose.</p>
    pub description: ::std::option::Option<::std::string::String>,
    /// <p>Metadata that can be used to define a package version’s configuration. For example, the S3 file location, configuration options that are being sent to the device or fleet.</p>
    /// <p>The combined size of all the attributes on a package version is limited to 3KB.</p>
    pub attributes: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
    /// <p>The various build components created during the build process such as libraries and configuration files that make up a software package version.</p>
    pub artifact: ::std::option::Option<crate::types::PackageVersionArtifact>,
    /// <p>The inline job document associated with a software package version used for a quick job deployment.</p>
    pub recipe: ::std::option::Option<::std::string::String>,
    /// <p>Metadata that can be used to manage the package version.</p>
    pub tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
    /// <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 client_token: ::std::option::Option<::std::string::String>,
}
impl CreatePackageVersionInput {
    /// <p>The name of the associated software package.</p>
    pub fn package_name(&self) -> ::std::option::Option<&str> {
        self.package_name.as_deref()
    }
    /// <p>The name of the new package version.</p>
    pub fn version_name(&self) -> ::std::option::Option<&str> {
        self.version_name.as_deref()
    }
    /// <p>A summary of the package version being created. This can be used to outline the package's contents or purpose.</p>
    pub fn description(&self) -> ::std::option::Option<&str> {
        self.description.as_deref()
    }
    /// <p>Metadata that can be used to define a package version’s configuration. For example, the S3 file location, configuration options that are being sent to the device or fleet.</p>
    /// <p>The combined size of all the attributes on a package version is limited to 3KB.</p>
    pub fn attributes(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::string::String>> {
        self.attributes.as_ref()
    }
    /// <p>The various build components created during the build process such as libraries and configuration files that make up a software package version.</p>
    pub fn artifact(&self) -> ::std::option::Option<&crate::types::PackageVersionArtifact> {
        self.artifact.as_ref()
    }
    /// <p>The inline job document associated with a software package version used for a quick job deployment.</p>
    pub fn recipe(&self) -> ::std::option::Option<&str> {
        self.recipe.as_deref()
    }
    /// <p>Metadata that can be used to manage the package version.</p>
    pub fn tags(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::string::String>> {
        self.tags.as_ref()
    }
    /// <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(&self) -> ::std::option::Option<&str> {
        self.client_token.as_deref()
    }
}
impl ::std::fmt::Debug for CreatePackageVersionInput {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("CreatePackageVersionInput");
        formatter.field("package_name", &self.package_name);
        formatter.field("version_name", &self.version_name);
        formatter.field("description", &"*** Sensitive Data Redacted ***");
        formatter.field("attributes", &"*** Sensitive Data Redacted ***");
        formatter.field("artifact", &self.artifact);
        formatter.field("recipe", &"*** Sensitive Data Redacted ***");
        formatter.field("tags", &self.tags);
        formatter.field("client_token", &self.client_token);
        formatter.finish()
    }
}
impl CreatePackageVersionInput {
    /// Creates a new builder-style object to manufacture [`CreatePackageVersionInput`](crate::operation::create_package_version::CreatePackageVersionInput).
    pub fn builder() -> crate::operation::create_package_version::builders::CreatePackageVersionInputBuilder {
        crate::operation::create_package_version::builders::CreatePackageVersionInputBuilder::default()
    }
}

/// A builder for [`CreatePackageVersionInput`](crate::operation::create_package_version::CreatePackageVersionInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default)]
#[non_exhaustive]
pub struct CreatePackageVersionInputBuilder {
    pub(crate) package_name: ::std::option::Option<::std::string::String>,
    pub(crate) version_name: ::std::option::Option<::std::string::String>,
    pub(crate) description: ::std::option::Option<::std::string::String>,
    pub(crate) attributes: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
    pub(crate) artifact: ::std::option::Option<crate::types::PackageVersionArtifact>,
    pub(crate) recipe: ::std::option::Option<::std::string::String>,
    pub(crate) tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
    pub(crate) client_token: ::std::option::Option<::std::string::String>,
}
impl CreatePackageVersionInputBuilder {
    /// <p>The name of the associated software package.</p>
    /// This field is required.
    pub fn package_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.package_name = ::std::option::Option::Some(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.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.package_name
    }
    /// <p>The name of the new package version.</p>
    /// This field is required.
    pub fn version_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.version_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The name of the new package version.</p>
    pub fn set_version_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.version_name = input;
        self
    }
    /// <p>The name of the new package version.</p>
    pub fn get_version_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.version_name
    }
    /// <p>A summary of the package version being created. This can be used to outline the package's contents or purpose.</p>
    pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.description = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>A summary of the package version being created. This can be used to outline the package's contents or purpose.</p>
    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.description = input;
        self
    }
    /// <p>A summary of the package version being created. This can be used to outline the package's contents or purpose.</p>
    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
        &self.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 S3 file location, configuration options that are being sent to the device or fleet.</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 {
        let mut hash_map = self.attributes.unwrap_or_default();
        hash_map.insert(k.into(), v.into());
        self.attributes = ::std::option::Option::Some(hash_map);
        self
    }
    /// <p>Metadata that can be used to define a package version’s configuration. For example, the S3 file location, configuration options that are being sent to the device or fleet.</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.attributes = input;
        self
    }
    /// <p>Metadata that can be used to define a package version’s configuration. For example, the S3 file location, configuration options that are being sent to the device or fleet.</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.attributes
    }
    /// <p>The various build components created during the build process such as libraries and configuration files that make up a software package version.</p>
    pub fn artifact(mut self, input: crate::types::PackageVersionArtifact) -> Self {
        self.artifact = ::std::option::Option::Some(input);
        self
    }
    /// <p>The various build components created during the build process such as libraries and configuration files that make up a software package version.</p>
    pub fn set_artifact(mut self, input: ::std::option::Option<crate::types::PackageVersionArtifact>) -> Self {
        self.artifact = input;
        self
    }
    /// <p>The various build components created during the build process such as libraries and configuration files that make up a software package version.</p>
    pub fn get_artifact(&self) -> &::std::option::Option<crate::types::PackageVersionArtifact> {
        &self.artifact
    }
    /// <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.recipe = ::std::option::Option::Some(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.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.recipe
    }
    /// Adds a key-value pair to `tags`.
    ///
    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
    ///
    /// <p>Metadata that can be used to manage the package version.</p>
    pub fn tags(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
        let mut hash_map = self.tags.unwrap_or_default();
        hash_map.insert(k.into(), v.into());
        self.tags = ::std::option::Option::Some(hash_map);
        self
    }
    /// <p>Metadata that can be used to manage the package version.</p>
    pub fn set_tags(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
        self.tags = input;
        self
    }
    /// <p>Metadata that can be used to manage the package version.</p>
    pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
        &self.tags
    }
    /// <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.client_token = ::std::option::Option::Some(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.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.client_token
    }
    /// Consumes the builder and constructs a [`CreatePackageVersionInput`](crate::operation::create_package_version::CreatePackageVersionInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::create_package_version::CreatePackageVersionInput, ::aws_smithy_types::error::operation::BuildError>
    {
        ::std::result::Result::Ok(crate::operation::create_package_version::CreatePackageVersionInput {
            package_name: self.package_name,
            version_name: self.version_name,
            description: self.description,
            attributes: self.attributes,
            artifact: self.artifact,
            recipe: self.recipe,
            tags: self.tags,
            client_token: self.client_token,
        })
    }
}
impl ::std::fmt::Debug for CreatePackageVersionInputBuilder {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("CreatePackageVersionInputBuilder");
        formatter.field("package_name", &self.package_name);
        formatter.field("version_name", &self.version_name);
        formatter.field("description", &"*** Sensitive Data Redacted ***");
        formatter.field("attributes", &"*** Sensitive Data Redacted ***");
        formatter.field("artifact", &self.artifact);
        formatter.field("recipe", &"*** Sensitive Data Redacted ***");
        formatter.field("tags", &self.tags);
        formatter.field("client_token", &self.client_token);
        formatter.finish()
    }
}