Class EncryptDataRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.paymentcryptographydata.model.PaymentCryptographyDataRequest
software.amazon.awssdk.services.paymentcryptographydata.model.EncryptDataRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<EncryptDataRequest.Builder,EncryptDataRequest>
@Generated("software.amazon.awssdk:codegen") public final class EncryptDataRequest extends PaymentCryptographyDataRequest implements ToCopyableBuilder<EncryptDataRequest.Builder,EncryptDataRequest>

  • Method Details

    • keyIdentifier

      public final String keyIdentifier()

      The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for plaintext encryption.

      When a WrappedKeyBlock is provided, this value will be the identifier to the key wrapping key. Otherwise, it is the key identifier used to perform the operation.

      Returns:
      The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for plaintext encryption.

      When a WrappedKeyBlock is provided, this value will be the identifier to the key wrapping key. Otherwise, it is the key identifier used to perform the operation.

    • plainText

      public final String plainText()

      The plaintext to be encrypted.

      For encryption using asymmetric keys, plaintext data length is constrained by encryption key strength that you define in KeyAlgorithm and padding type that you define in AsymmetricEncryptionAttributes. For more information, see Encrypt data in the Amazon Web Services Payment Cryptography User Guide.

      Returns:
      The plaintext to be encrypted.

      For encryption using asymmetric keys, plaintext data length is constrained by encryption key strength that you define in KeyAlgorithm and padding type that you define in AsymmetricEncryptionAttributes. For more information, see Encrypt data in the Amazon Web Services Payment Cryptography User Guide.

    • encryptionAttributes

      public final EncryptionDecryptionAttributes encryptionAttributes()

      The encryption key type and attributes for plaintext encryption.

      Returns:
      The encryption key type and attributes for plaintext encryption.

    • wrappedKey

      public final WrappedKey wrappedKey()

      The WrappedKeyBlock containing the encryption key for plaintext encryption.

      Returns:
      The WrappedKeyBlock containing the encryption key for plaintext encryption.

    • toBuilder

      public EncryptDataRequest.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<EncryptDataRequest.Builder,EncryptDataRequest>
      Specified by:
      toBuilder in class PaymentCryptographyDataRequest
      Returns:
      a builder for type T

    • builder

      public static EncryptDataRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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