Class KeySummary

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

Metadata about an Amazon Web Services Payment Cryptography key.

See Also:

  • Method Details

    • keyArn

      public final String keyArn()

      The Amazon Resource Name (ARN) of the key.

      Returns:
      The Amazon Resource Name (ARN) of the key.

    • keyState

      public final KeyState keyState()

      The state of an Amazon Web Services Payment Cryptography that is being created or deleted.

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

      Returns:
      The state of an Amazon Web Services Payment Cryptography that is being created or deleted.
      See Also:

    • keyStateAsString

      public final String keyStateAsString()

      The state of an Amazon Web Services Payment Cryptography that is being created or deleted.

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

      Returns:
      The state of an Amazon Web Services Payment Cryptography that is being created or deleted.
      See Also:

    • keyAttributes

      public final KeyAttributes 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.

      Returns:
      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.

    • keyCheckValue

      public final String keyCheckValue()

      The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed.

      Returns:
      The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed.

    • exportable

      public final Boolean exportable()

      Specifies whether the key is exportable. This data is immutable after the key is created.

      Returns:
      Specifies whether the key is exportable. This data is immutable after the key is created.

    • enabled

      public final Boolean enabled()

      Specifies whether the key is enabled.

      Returns:
      Specifies whether the key is enabled.

    • multiRegionKeyType

      public final MultiRegionKeyType multiRegionKeyType()

      Indicates whether this key is a multi-region key and its role in the multi-region key hierarchy.

      Multi-region keys allow the same key material to be used across multiple Amazon Web Services Regions. This field specifies whether the key is a primary key (which can be replicated to other regions) or a replica key (which is a copy of a primary key in another region).

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

      Returns:
      Indicates whether this key is a multi-region key and its role in the multi-region key hierarchy.

      Multi-region keys allow the same key material to be used across multiple Amazon Web Services Regions. This field specifies whether the key is a primary key (which can be replicated to other regions) or a replica key (which is a copy of a primary key in another region).

      See Also:

    • multiRegionKeyTypeAsString

      public final String multiRegionKeyTypeAsString()

      Indicates whether this key is a multi-region key and its role in the multi-region key hierarchy.

      Multi-region keys allow the same key material to be used across multiple Amazon Web Services Regions. This field specifies whether the key is a primary key (which can be replicated to other regions) or a replica key (which is a copy of a primary key in another region).

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

      Returns:
      Indicates whether this key is a multi-region key and its role in the multi-region key hierarchy.

      Multi-region keys allow the same key material to be used across multiple Amazon Web Services Regions. This field specifies whether the key is a primary key (which can be replicated to other regions) or a replica key (which is a copy of a primary key in another region).

      See Also:

    • primaryRegion

      public final String primaryRegion()
      Returns the value of the PrimaryRegion property for this object.
      Returns:
      The value of the PrimaryRegion property for this object.

    • toBuilder

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

    • builder

      public static KeySummary.Builder builder()

    • serializableBuilderClass

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