aws-sdk-paymentcryptographydata 1.105.0

AWS SDK for Payment Cryptography Data Plane
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 GenerateMacOutput {
    /// <p>The <code>keyARN</code> of the encryption key that Amazon Web Services Payment Cryptography uses for MAC generation.</p>
    pub key_arn: ::std::string::String,
    /// <p>The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.</p>
    /// <p>Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.</p>
    pub key_check_value: ::std::string::String,
    /// <p>The MAC cryptogram generated within Amazon Web Services Payment Cryptography.</p>
    pub mac: ::std::string::String,
    _request_id: Option<String>,
}
impl GenerateMacOutput {
    /// <p>The <code>keyARN</code> of the encryption key that Amazon Web Services Payment Cryptography uses for MAC generation.</p>
    pub fn key_arn(&self) -> &str {
        use std::ops::Deref;
        self.key_arn.deref()
    }
    /// <p>The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.</p>
    /// <p>Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.</p>
    pub fn key_check_value(&self) -> &str {
        use std::ops::Deref;
        self.key_check_value.deref()
    }
    /// <p>The MAC cryptogram generated within Amazon Web Services Payment Cryptography.</p>
    pub fn mac(&self) -> &str {
        use std::ops::Deref;
        self.mac.deref()
    }
}
impl ::std::fmt::Debug for GenerateMacOutput {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("GenerateMacOutput");
        formatter.field("key_arn", &self.key_arn);
        formatter.field("key_check_value", &self.key_check_value);
        formatter.field("mac", &"*** Sensitive Data Redacted ***");
        formatter.field("_request_id", &self._request_id);
        formatter.finish()
    }
}
impl ::aws_types::request_id::RequestId for GenerateMacOutput {
    fn request_id(&self) -> Option<&str> {
        self._request_id.as_deref()
    }
}
impl GenerateMacOutput {
    /// Creates a new builder-style object to manufacture [`GenerateMacOutput`](crate::operation::generate_mac::GenerateMacOutput).
    pub fn builder() -> crate::operation::generate_mac::builders::GenerateMacOutputBuilder {
        crate::operation::generate_mac::builders::GenerateMacOutputBuilder::default()
    }
}

/// A builder for [`GenerateMacOutput`](crate::operation::generate_mac::GenerateMacOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default)]
#[non_exhaustive]
pub struct GenerateMacOutputBuilder {
    pub(crate) key_arn: ::std::option::Option<::std::string::String>,
    pub(crate) key_check_value: ::std::option::Option<::std::string::String>,
    pub(crate) mac: ::std::option::Option<::std::string::String>,
    _request_id: Option<String>,
}
impl GenerateMacOutputBuilder {
    /// <p>The <code>keyARN</code> of the encryption key that Amazon Web Services Payment Cryptography uses for MAC generation.</p>
    /// This field is required.
    pub fn key_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.key_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The <code>keyARN</code> of the encryption key that Amazon Web Services Payment Cryptography uses for MAC generation.</p>
    pub fn set_key_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.key_arn = input;
        self
    }
    /// <p>The <code>keyARN</code> of the encryption key that Amazon Web Services Payment Cryptography uses for MAC generation.</p>
    pub fn get_key_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.key_arn
    }
    /// <p>The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.</p>
    /// <p>Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.</p>
    /// This field is required.
    pub fn key_check_value(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.key_check_value = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.</p>
    /// <p>Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.</p>
    pub fn set_key_check_value(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.key_check_value = input;
        self
    }
    /// <p>The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.</p>
    /// <p>Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.</p>
    pub fn get_key_check_value(&self) -> &::std::option::Option<::std::string::String> {
        &self.key_check_value
    }
    /// <p>The MAC cryptogram generated within Amazon Web Services Payment Cryptography.</p>
    /// This field is required.
    pub fn mac(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.mac = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The MAC cryptogram generated within Amazon Web Services Payment Cryptography.</p>
    pub fn set_mac(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.mac = input;
        self
    }
    /// <p>The MAC cryptogram generated within Amazon Web Services Payment Cryptography.</p>
    pub fn get_mac(&self) -> &::std::option::Option<::std::string::String> {
        &self.mac
    }
    pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
        self._request_id = Some(request_id.into());
        self
    }

    pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
        self._request_id = request_id;
        self
    }
    /// Consumes the builder and constructs a [`GenerateMacOutput`](crate::operation::generate_mac::GenerateMacOutput).
    /// This method will fail if any of the following fields are not set:
    /// - [`key_arn`](crate::operation::generate_mac::builders::GenerateMacOutputBuilder::key_arn)
    /// - [`key_check_value`](crate::operation::generate_mac::builders::GenerateMacOutputBuilder::key_check_value)
    /// - [`mac`](crate::operation::generate_mac::builders::GenerateMacOutputBuilder::mac)
    pub fn build(self) -> ::std::result::Result<crate::operation::generate_mac::GenerateMacOutput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::generate_mac::GenerateMacOutput {
            key_arn: self.key_arn.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "key_arn",
                    "key_arn was not specified but it is required when building GenerateMacOutput",
                )
            })?,
            key_check_value: self.key_check_value.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "key_check_value",
                    "key_check_value was not specified but it is required when building GenerateMacOutput",
                )
            })?,
            mac: self.mac.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "mac",
                    "mac was not specified but it is required when building GenerateMacOutput",
                )
            })?,
            _request_id: self._request_id,
        })
    }
}
impl ::std::fmt::Debug for GenerateMacOutputBuilder {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("GenerateMacOutputBuilder");
        formatter.field("key_arn", &self.key_arn);
        formatter.field("key_check_value", &self.key_check_value);
        formatter.field("mac", &"*** Sensitive Data Redacted ***");
        formatter.field("_request_id", &self._request_id);
        formatter.finish()
    }
}