Class WrappedWorkingKey

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

The parameter information of the outgoing wrapped key block.

See Also:

  • Method Details

    • wrappedKeyMaterial

      public final String wrappedKeyMaterial()

      The wrapped key block of the outgoing transaction key.

      Returns:
      The wrapped key block of the outgoing transaction key.

    • keyCheckValue

      public final String keyCheckValue()

      The key check value (KCV) of the key contained within the outgoing TR31WrappedKeyBlock.

      The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. For more information on KCV, see KCV in the Amazon Web Services Payment Cryptography User Guide.

      Returns:
      The key check value (KCV) of the key contained within the outgoing TR31WrappedKeyBlock.

      The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. For more information on KCV, see KCV in the Amazon Web Services Payment Cryptography User Guide.

    • wrappedKeyMaterialFormat

      public final WrappedKeyMaterialFormat wrappedKeyMaterialFormat()

      The key block format of the wrapped key.

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

      Returns:
      The key block format of the wrapped key.
      See Also:

    • wrappedKeyMaterialFormatAsString

      public final String wrappedKeyMaterialFormatAsString()

      The key block format of the wrapped key.

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

      Returns:
      The key block format of the wrapped key.
      See Also:

    • toBuilder

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

    • builder

      public static WrappedWorkingKey.Builder builder()

    • serializableBuilderClass

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