Class KeyAttributes

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

The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.

See Also:

  • Method Details

    • keyUsage

      public final KeyUsage keyUsage()

      The cryptographic usage of an Amazon Web Services Payment Cryptography key as defined in section A.5.2 of the TR-31 spec.

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

      Returns:
      The cryptographic usage of an Amazon Web Services Payment Cryptography key as defined in section A.5.2 of the TR-31 spec.
      See Also:

    • keyUsageAsString

      public final String keyUsageAsString()

      The cryptographic usage of an Amazon Web Services Payment Cryptography key as defined in section A.5.2 of the TR-31 spec.

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

      Returns:
      The cryptographic usage of an Amazon Web Services Payment Cryptography key as defined in section A.5.2 of the TR-31 spec.
      See Also:

    • keyClass

      public final KeyClass keyClass()

      The type of Amazon Web Services Payment Cryptography key to create, which determines the classification of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.

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

      Returns:
      The type of Amazon Web Services Payment Cryptography key to create, which determines the classification of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.
      See Also:

    • keyClassAsString

      public final String keyClassAsString()

      The type of Amazon Web Services Payment Cryptography key to create, which determines the classification of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.

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

      Returns:
      The type of Amazon Web Services Payment Cryptography key to create, which determines the classification of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.
      See Also:

    • keyAlgorithm

      public final KeyAlgorithm keyAlgorithm()

      The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.

      For symmetric keys, Amazon Web Services Payment Cryptography supports AES and TDES algorithms. For asymmetric keys, Amazon Web Services Payment Cryptography supports RSA and ECC_NIST algorithms.

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

      Returns:
      The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.

      For symmetric keys, Amazon Web Services Payment Cryptography supports AES and TDES algorithms. For asymmetric keys, Amazon Web Services Payment Cryptography supports RSA and ECC_NIST algorithms.

      See Also:

    • keyAlgorithmAsString

      public final String keyAlgorithmAsString()

      The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.

      For symmetric keys, Amazon Web Services Payment Cryptography supports AES and TDES algorithms. For asymmetric keys, Amazon Web Services Payment Cryptography supports RSA and ECC_NIST algorithms.

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

      Returns:
      The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.

      For symmetric keys, Amazon Web Services Payment Cryptography supports AES and TDES algorithms. For asymmetric keys, Amazon Web Services Payment Cryptography supports RSA and ECC_NIST algorithms.

      See Also:

    • keyModesOfUse

      public final KeyModesOfUse keyModesOfUse()

      The list of cryptographic operations that you can perform using the key.

      Returns:
      The list of cryptographic operations that you can perform using the key.

    • toBuilder

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

    • builder

      public static KeyAttributes.Builder builder()

    • serializableBuilderClass

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