software.amazon.awssdk.services.paymentcryptography.model

Class KeySummary

java.lang.Object

software.amazon.awssdk.services.paymentcryptography.model.KeySummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<KeySummary.Builder,KeySummary>

@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	KeySummary.Builder

Method Summary

Modifier and Type	Method and Description
static KeySummary.Builder	builder()
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.
KeyState	keyState() The state of an Amazon Web Services Payment Cryptography that is being created or deleted.
String	keyStateAsString() The state of an Amazon Web Services Payment Cryptography that is being created or deleted.
List<SdkField<?>>	sdkFields()
static Class<? extends KeySummary.Builder>	serializableBuilderClass()
KeySummary.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

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. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or "00" or "01" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.

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. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or "00" or "01" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.

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:

KeyState

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:

KeyState

toBuilder

public KeySummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<KeySummary.Builder,KeySummary>

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)

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