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

    • mode

      public final EncryptionMode mode()

      The block cipher method to use for encryption.

      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 method to use for encryption.
      See Also:
    • modeAsString

      public final String modeAsString()

      The block cipher method to use for encryption.

      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 method to use for encryption.
      See Also:
    • initializationVector

      public final String initializationVector()

      An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.

      Returns:
      An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.
    • 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

      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.
    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.