Class ExportTr34KeyBlock

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

Parameter information for key material export using the asymmetric TR-34 key exchange method.

See Also:

  • Method Details

    • certificateAuthorityPublicKeyIdentifier

      public final String certificateAuthorityPublicKeyIdentifier()

      The KeyARN of the certificate chain that signs the wrapping key certificate during TR-34 key export.

      Returns:
      The KeyARN of the certificate chain that signs the wrapping key certificate during TR-34 key export.

    • wrappingKeyCertificate

      public final String wrappingKeyCertificate()

      The KeyARN of the wrapping key certificate. Amazon Web Services Payment Cryptography uses this certificate to wrap the key under export.

      Returns:
      The KeyARN of the wrapping key certificate. Amazon Web Services Payment Cryptography uses this certificate to wrap the key under export.

    • exportToken

      public final String exportToken()

      The export token to initiate key export from Amazon Web Services Payment Cryptography. It also contains the signing key certificate that will sign the wrapped key during TR-34 key block generation. Call GetParametersForExport to receive an export token. It expires after 30 days. You can use the same export token to export multiple keys from the same service account.

      Returns:
      The export token to initiate key export from Amazon Web Services Payment Cryptography. It also contains the signing key certificate that will sign the wrapped key during TR-34 key block generation. Call GetParametersForExport to receive an export token. It expires after 30 days. You can use the same export token to export multiple keys from the same service account.

    • keyBlockFormat

      public final Tr34KeyBlockFormat keyBlockFormat()

      The format of key block that Amazon Web Services Payment Cryptography will use during key export.

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

      Returns:
      The format of key block that Amazon Web Services Payment Cryptography will use during key export.
      See Also:

    • keyBlockFormatAsString

      public final String keyBlockFormatAsString()

      The format of key block that Amazon Web Services Payment Cryptography will use during key export.

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

      Returns:
      The format of key block that Amazon Web Services Payment Cryptography will use during key export.
      See Also:

    • randomNonce

      public final String randomNonce()

      A random number value that is unique to the TR-34 key block generated using 2 pass. The operation will fail, if a random nonce value is not provided for a TR-34 key block generated using 2 pass.

      Returns:
      A random number value that is unique to the TR-34 key block generated using 2 pass. The operation will fail, if a random nonce value is not provided for a TR-34 key block generated using 2 pass.

    • keyBlockHeaders

      public final KeyBlockHeaders keyBlockHeaders()

      Optional metadata for export associated with the key material. This data is signed but transmitted in clear text.

      Returns:
      Optional metadata for export associated with the key material. This data is signed but transmitted in clear text.

    • toBuilder

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

    • builder

      public static ExportTr34KeyBlock.Builder builder()

    • serializableBuilderClass

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