Class ExportDiffieHellmanTr31KeyBlock

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

Key derivation parameter information for key material export using asymmetric ECDH key exchange method.

See Also:

  • Method Details

    • privateKeyIdentifier

      public final String privateKeyIdentifier()

      The keyARN of the asymmetric ECC key created within Amazon Web Services Payment Cryptography.

      Returns:
      The keyARN of the asymmetric ECC key created within Amazon Web Services Payment Cryptography.

    • certificateAuthorityPublicKeyIdentifier

      public final String certificateAuthorityPublicKeyIdentifier()

      The keyARN of the CA that signed the PublicKeyCertificate for the client's receiving ECC key pair.

      Returns:
      The keyARN of the CA that signed the PublicKeyCertificate for the client's receiving ECC key pair.

    • publicKeyCertificate

      public final String publicKeyCertificate()

      The public key certificate of the client's receiving ECC key pair, in PEM format (base64 encoded), to use for ECDH key derivation.

      Returns:
      The public key certificate of the client's receiving ECC key pair, in PEM format (base64 encoded), to use for ECDH key derivation.

    • deriveKeyAlgorithm

      public final SymmetricKeyAlgorithm deriveKeyAlgorithm()

      The key algorithm of the shared derived ECDH key.

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

      Returns:
      The key algorithm of the shared derived ECDH key.
      See Also:

    • deriveKeyAlgorithmAsString

      public final String deriveKeyAlgorithmAsString()

      The key algorithm of the shared derived ECDH key.

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

      Returns:
      The key algorithm of the shared derived ECDH key.
      See Also:

    • keyDerivationFunction

      public final KeyDerivationFunction keyDerivationFunction()

      The key derivation function to use when deriving a key using ECDH.

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

      Returns:
      The key derivation function to use when deriving a key using ECDH.
      See Also:

    • keyDerivationFunctionAsString

      public final String keyDerivationFunctionAsString()

      The key derivation function to use when deriving a key using ECDH.

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

      Returns:
      The key derivation function to use when deriving a key using ECDH.
      See Also:

    • keyDerivationHashAlgorithm

      public final KeyDerivationHashAlgorithm keyDerivationHashAlgorithm()

      The hash type to use when deriving a key using ECDH.

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

      Returns:
      The hash type to use when deriving a key using ECDH.
      See Also:

    • keyDerivationHashAlgorithmAsString

      public final String keyDerivationHashAlgorithmAsString()

      The hash type to use when deriving a key using ECDH.

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

      Returns:
      The hash type to use when deriving a key using ECDH.
      See Also:

    • derivationData

      public final DiffieHellmanDerivationData derivationData()

      The shared information used when deriving a key using ECDH.

      Returns:
      The shared information used when deriving a key using ECDH.

    • keyBlockHeaders

      public final KeyBlockHeaders keyBlockHeaders()
      Returns the value of the KeyBlockHeaders property for this object.
      Returns:
      The value of the KeyBlockHeaders property for this object.

    • toBuilder

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

    • builder

      public static ExportDiffieHellmanTr31KeyBlock.Builder builder()

    • serializableBuilderClass

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