Package software.amazon.awssdk.services.paymentcryptographydata.model

Class SymmetricEncryptionAttributes

java.lang.Object
software.amazon.awssdk.services.paymentcryptographydata.model.SymmetricEncryptionAttributes
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SymmetricEncryptionAttributes.Builder,SymmetricEncryptionAttributes>
@Generated("software.amazon.awssdk:codegen") public final class SymmetricEncryptionAttributes extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SymmetricEncryptionAttributes.Builder,SymmetricEncryptionAttributes>

Parameters requried to encrypt plaintext data using symmetric keys.

See Also:

  • Method Details

    • initializationVector

      public final String initializationVector()

      An input to cryptographic primitive used to provide the intial state. The InitializationVector is typically required have a random or psuedo-random value, but sometimes it only needs to be unpredictable or unique. If a value is not provided, Amazon Web Services Payment Cryptography generates a random value.

      Returns:
      An input to cryptographic primitive used to provide the intial state. The InitializationVector is typically required have a random or psuedo-random value, but sometimes it only needs to be unpredictable or unique. If a value is not provided, Amazon Web Services Payment Cryptography generates a random value.

    • mode

      public final EncryptionMode mode()

      The block cipher mode of operation. Block ciphers are designed to encrypt a block of data of fixed size (for example, 128 bits). The size of the input block is usually same as the size of the encrypted output block, while the key length can be different. A mode of operation describes how to repeatedly apply a cipher's single-block operation to securely transform amounts of data larger than a block.

      If the service returns an enum value that is not available in the current SDK version, mode will return EncryptionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().

      Returns:
      The block cipher mode of operation. Block ciphers are designed to encrypt a block of data of fixed size (for example, 128 bits). The size of the input block is usually same as the size of the encrypted output block, while the key length can be different. A mode of operation describes how to repeatedly apply a cipher's single-block operation to securely transform amounts of data larger than a block.
      See Also:

    • modeAsString

      public final String modeAsString()

      The block cipher mode of operation. Block ciphers are designed to encrypt a block of data of fixed size (for example, 128 bits). The size of the input block is usually same as the size of the encrypted output block, while the key length can be different. A mode of operation describes how to repeatedly apply a cipher's single-block operation to securely transform amounts of data larger than a block.

      If the service returns an enum value that is not available in the current SDK version, mode will return EncryptionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().

      Returns:
      The block cipher mode of operation. Block ciphers are designed to encrypt a block of data of fixed size (for example, 128 bits). The size of the input block is usually same as the size of the encrypted output block, while the key length can be different. A mode of operation describes how to repeatedly apply a cipher's single-block operation to securely transform amounts of data larger than a block.
      See Also:

    • paddingType

      public final PaddingType paddingType()

      The padding to be included with the data.

      If the service returns an enum value that is not available in the current SDK version, paddingType will return PaddingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from paddingTypeAsString().

      Returns:
      The padding to be included with the data.
      See Also:

    • paddingTypeAsString

      public final String paddingTypeAsString()

      The padding to be included with the data.

      If the service returns an enum value that is not available in the current SDK version, paddingType will return PaddingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from paddingTypeAsString().

      Returns:
      The padding to be included with the data.
      See Also:

    • toBuilder

      public SymmetricEncryptionAttributes.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<SymmetricEncryptionAttributes.Builder,SymmetricEncryptionAttributes>
      Returns:
      a builder for type T

    • builder

      public static SymmetricEncryptionAttributes.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SymmetricEncryptionAttributes.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.