Class KeyModesOfUse

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

The list of cryptographic operations that you can perform using the key. The modes of use are defined in section A.5.3 of the TR-31 spec.

See Also:

  • Method Details

    • encrypt

      public final Boolean encrypt()

      Specifies whether an Amazon Web Services Payment Cryptography key can be used to encrypt data.

      Returns:
      Specifies whether an Amazon Web Services Payment Cryptography key can be used to encrypt data.

    • decrypt

      public final Boolean decrypt()

      Specifies whether an Amazon Web Services Payment Cryptography key can be used to decrypt data.

      Returns:
      Specifies whether an Amazon Web Services Payment Cryptography key can be used to decrypt data.

    • wrap

      public final Boolean wrap()

      Specifies whether an Amazon Web Services Payment Cryptography key can be used to wrap other keys.

      Returns:
      Specifies whether an Amazon Web Services Payment Cryptography key can be used to wrap other keys.

    • unwrap

      public final Boolean unwrap()

      Specifies whether an Amazon Web Services Payment Cryptography key can be used to unwrap other keys.

      Returns:
      Specifies whether an Amazon Web Services Payment Cryptography key can be used to unwrap other keys.

    • generate

      public final Boolean generate()

      Specifies whether an Amazon Web Services Payment Cryptography key can be used to generate and verify other card and PIN verification keys.

      Returns:
      Specifies whether an Amazon Web Services Payment Cryptography key can be used to generate and verify other card and PIN verification keys.

    • sign

      public final Boolean sign()

      Specifies whether an Amazon Web Services Payment Cryptography key can be used for signing.

      Returns:
      Specifies whether an Amazon Web Services Payment Cryptography key can be used for signing.

    • verify

      public final Boolean verify()

      Specifies whether an Amazon Web Services Payment Cryptography key can be used to verify signatures.

      Returns:
      Specifies whether an Amazon Web Services Payment Cryptography key can be used to verify signatures.

    • deriveKey

      public final Boolean deriveKey()

      Specifies whether an Amazon Web Services Payment Cryptography key can be used to derive new keys.

      Returns:
      Specifies whether an Amazon Web Services Payment Cryptography key can be used to derive new keys.

    • noRestrictions

      public final Boolean noRestrictions()

      Specifies whether an Amazon Web Services Payment Cryptography key has no special restrictions other than the restrictions implied by KeyUsage.

      Returns:
      Specifies whether an Amazon Web Services Payment Cryptography key has no special restrictions other than the restrictions implied by KeyUsage.

    • toBuilder

      public KeyModesOfUse.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<KeyModesOfUse.Builder,KeyModesOfUse>
      Returns:
      a builder for type T

    • builder

      public static KeyModesOfUse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends KeyModesOfUse.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.