java.lang.Object
- software.amazon.awssdk.services.paymentcryptography.model.Key

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Key.Builder,Key>
```
@Generated("software.amazon.awssdk:codegen")
public final class Key
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Key.Builder,Key>
```
Metadata about an Amazon Web Services Payment Cryptography key.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Key.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static Key.Builder`	`builder()`
`Instant`	`createTimestamp()`	The date and time when the key was created.
`Instant`	`deletePendingTimestamp()`	The date and time after which Amazon Web Services Payment Cryptography will delete the key.
`Instant`	`deleteTimestamp()`	The date and time after which Amazon Web Services Payment Cryptography will delete the key.
`Boolean`	`enabled()`	Specifies whether the key is enabled.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Boolean`	`exportable()`	Specifies whether the key is exportable.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`keyArn()`	The Amazon Resource Name (ARN) of the key.
`KeyAttributes`	`keyAttributes()`	The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key.
`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.
`KeyCheckValueAlgorithm`	`keyCheckValueAlgorithm()`	The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV).
`String`	`keyCheckValueAlgorithmAsString()`	The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV).
`KeyOrigin`	`keyOrigin()`	The source of the key material.
`String`	`keyOriginAsString()`	The source of the key material.
`KeyState`	`keyState()`	The state of key that is being created or deleted.
`String`	`keyStateAsString()`	The state of key that is being created or deleted.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Key.Builder>`	`serializableBuilderClass()`
`Key.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Instant`	`usageStartTimestamp()`	The date and time after which Amazon Web Services Payment Cryptography will start using the key material for cryptographic operations.
`Instant`	`usageStopTimestamp()`	The date and time after which Amazon Web Services Payment Cryptography will stop using the key material for cryptographic operations.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - createTimestamp
```
public final Instant createTimestamp()
```
    The date and time when the key was created.
    
    Returns:
    
    The date and time when the key was created.
  - deletePendingTimestamp
```
public final Instant deletePendingTimestamp()
```
    The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when KeyState is DELETE_PENDING and the key is scheduled for deletion.
    
    Returns:
    
    The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when KeyState is DELETE_PENDING and the key is scheduled for deletion.
  - deleteTimestamp
```
public final Instant deleteTimestamp()
```
    The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when when the KeyState is DELETE_COMPLETE and the Amazon Web Services Payment Cryptography key is deleted.
    
    Returns:
    
    The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when when the KeyState is DELETE_COMPLETE and the Amazon Web Services Payment Cryptography key is deleted.
  - enabled
```
public final Boolean enabled()
```
    Specifies whether the key is enabled.
    
    Returns:
    
    Specifies whether the key is enabled.
  - 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.
  - keyArn
```
public final String keyArn()
```
    The Amazon Resource Name (ARN) of the key.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the key.
  - 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.
  - keyCheckValueAlgorithm
```
public final KeyCheckValueAlgorithm keyCheckValueAlgorithm()
```
    The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.
    
    For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.
    
    If the service returns an enum value that is not available in the current SDK version, keyCheckValueAlgorithm will return KeyCheckValueAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyCheckValueAlgorithmAsString().
    
    Returns:
    
    The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.
    
    For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.
    
    See Also:
    
    KeyCheckValueAlgorithm
  - keyCheckValueAlgorithmAsString
```
public final String keyCheckValueAlgorithmAsString()
```
    The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.
    
    For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.
    
    If the service returns an enum value that is not available in the current SDK version, keyCheckValueAlgorithm will return KeyCheckValueAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyCheckValueAlgorithmAsString().
    
    Returns:
    
    The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.
    
    For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.
    
    See Also:
    
    KeyCheckValueAlgorithm
  - keyOrigin
```
public final KeyOrigin keyOrigin()
```
    The source of the key material. For keys created within Amazon Web Services Payment Cryptography, the value is AWS_PAYMENT_CRYPTOGRAPHY. For keys imported into Amazon Web Services Payment Cryptography, the value is EXTERNAL.
    
    If the service returns an enum value that is not available in the current SDK version, keyOrigin will return KeyOrigin.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyOriginAsString().
    
    Returns:
    
    The source of the key material. For keys created within Amazon Web Services Payment Cryptography, the value is AWS_PAYMENT_CRYPTOGRAPHY. For keys imported into Amazon Web Services Payment Cryptography, the value is EXTERNAL.
    
    See Also:
    
    KeyOrigin
  - keyOriginAsString
```
public final String keyOriginAsString()
```
    The source of the key material. For keys created within Amazon Web Services Payment Cryptography, the value is AWS_PAYMENT_CRYPTOGRAPHY. For keys imported into Amazon Web Services Payment Cryptography, the value is EXTERNAL.
    
    If the service returns an enum value that is not available in the current SDK version, keyOrigin will return KeyOrigin.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyOriginAsString().
    
    Returns:
    
    The source of the key material. For keys created within Amazon Web Services Payment Cryptography, the value is AWS_PAYMENT_CRYPTOGRAPHY. For keys imported into Amazon Web Services Payment Cryptography, the value is EXTERNAL.
    
    See Also:
    
    KeyOrigin
  - keyState
```
public final KeyState keyState()
```
    The state of key 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 key that is being created or deleted.
    
    See Also:
    
    KeyState
  - keyStateAsString
```
public final String keyStateAsString()
```
    The state of key 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 key that is being created or deleted.
    
    See Also:
    
    KeyState
  - usageStartTimestamp
```
public final Instant usageStartTimestamp()
```
    The date and time after which Amazon Web Services Payment Cryptography will start using the key material for cryptographic operations.
    
    Returns:
    
    The date and time after which Amazon Web Services Payment Cryptography will start using the key material for cryptographic operations.
  - usageStopTimestamp
```
public final Instant usageStopTimestamp()
```
    The date and time after which Amazon Web Services Payment Cryptography will stop using the key material for cryptographic operations.
    
    Returns:
    
    The date and time after which Amazon Web Services Payment Cryptography will stop using the key material for cryptographic operations.
  - toBuilder
```
public Key.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Key.Builder,Key>
  - builder
```
public static Key.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Key.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class Key

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

createTimestamp

deletePendingTimestamp

deleteTimestamp

enabled

exportable

keyArn

keyAttributes

keyCheckValue

keyCheckValueAlgorithm

keyCheckValueAlgorithmAsString

keyOrigin

keyOriginAsString

keyState

keyStateAsString

usageStartTimestamp

usageStopTimestamp

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields