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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<KeyAttributes.Builder,KeyAttributes>
```
@Generated("software.amazon.awssdk:codegen")
public final class KeyAttributes
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<KeyAttributes.Builder,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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface KeyAttributes.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static KeyAttributes.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`KeyAlgorithm`	`keyAlgorithm()`	The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.
`String`	`keyAlgorithmAsString()`	The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.
`KeyClass`	`keyClass()`	The type of Amazon Web Services Payment Cryptography key to create, which determines the classiﬁcation of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.
`String`	`keyClassAsString()`	The type of Amazon Web Services Payment Cryptography key to create, which determines the classiﬁcation of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.
`KeyModesOfUse`	`keyModesOfUse()`	The list of cryptographic operations that you can perform using the key.
`KeyUsage`	`keyUsage()`	The cryptographic usage of an Amazon Web Services Payment Cryptography key as deﬁned in section A.5.2 of the TR-31 spec.
`String`	`keyUsageAsString()`	The cryptographic usage of an Amazon Web Services Payment Cryptography key as deﬁned in section A.5.2 of the TR-31 spec.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends KeyAttributes.Builder>`	`serializableBuilderClass()`
`KeyAttributes.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
  - keyAlgorithm
```
public final KeyAlgorithm keyAlgorithm()
```
    The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.
    
    For symmetric keys, Amazon Web Services Payment Cryptography supports AES and TDES algorithms. For asymmetric keys, Amazon Web Services Payment Cryptography supports RSA and ECC_NIST algorithms.
    
    If the service returns an enum value that is not available in the current SDK version, keyAlgorithm will return KeyAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyAlgorithmAsString().
    
    Returns:
    
    The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.
    
    For symmetric keys, Amazon Web Services Payment Cryptography supports AES and TDES algorithms. For asymmetric keys, Amazon Web Services Payment Cryptography supports RSA and ECC_NIST algorithms.
    
    See Also:
    
    KeyAlgorithm
  - keyAlgorithmAsString
```
public final String keyAlgorithmAsString()
```
    The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.
    
    For symmetric keys, Amazon Web Services Payment Cryptography supports AES and TDES algorithms. For asymmetric keys, Amazon Web Services Payment Cryptography supports RSA and ECC_NIST algorithms.
    
    If the service returns an enum value that is not available in the current SDK version, keyAlgorithm will return KeyAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyAlgorithmAsString().
    
    Returns:
    
    The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.
    
    For symmetric keys, Amazon Web Services Payment Cryptography supports AES and TDES algorithms. For asymmetric keys, Amazon Web Services Payment Cryptography supports RSA and ECC_NIST algorithms.
    
    See Also:
    
    KeyAlgorithm
  - keyClass
```
public final KeyClass keyClass()
```
    The type of Amazon Web Services Payment Cryptography key to create, which determines the classiﬁcation of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.
    
    If the service returns an enum value that is not available in the current SDK version, keyClass will return KeyClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyClassAsString().
    
    Returns:
    
    The type of Amazon Web Services Payment Cryptography key to create, which determines the classiﬁcation of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.
    
    See Also:
    
    KeyClass
  - keyClassAsString
```
public final String keyClassAsString()
```
    The type of Amazon Web Services Payment Cryptography key to create, which determines the classiﬁcation of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.
    
    If the service returns an enum value that is not available in the current SDK version, keyClass will return KeyClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyClassAsString().
    
    Returns:
    
    The type of Amazon Web Services Payment Cryptography key to create, which determines the classiﬁcation of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.
    
    See Also:
    
    KeyClass
  - keyModesOfUse
```
public final KeyModesOfUse keyModesOfUse()
```
    The list of cryptographic operations that you can perform using the key.
    
    Returns:
    
    The list of cryptographic operations that you can perform using the key.
  - keyUsage
```
public final KeyUsage keyUsage()
```
    The cryptographic usage of an Amazon Web Services Payment Cryptography key as deﬁned in section A.5.2 of the TR-31 spec.
    
    If the service returns an enum value that is not available in the current SDK version, keyUsage will return KeyUsage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyUsageAsString().
    
    Returns:
    
    The cryptographic usage of an Amazon Web Services Payment Cryptography key as deﬁned in section A.5.2 of the TR-31 spec.
    
    See Also:
    
    KeyUsage
  - keyUsageAsString
```
public final String keyUsageAsString()
```
    The cryptographic usage of an Amazon Web Services Payment Cryptography key as deﬁned in section A.5.2 of the TR-31 spec.
    
    If the service returns an enum value that is not available in the current SDK version, keyUsage will return KeyUsage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyUsageAsString().
    
    Returns:
    
    The cryptographic usage of an Amazon Web Services Payment Cryptography key as deﬁned in section A.5.2 of the TR-31 spec.
    
    See Also:
    
    KeyUsage
  - toBuilder
```
public KeyAttributes.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<KeyAttributes.Builder,KeyAttributes>
  - builder
```
public static KeyAttributes.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends KeyAttributes.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 KeyAttributes

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

keyAlgorithm

keyAlgorithmAsString

keyClass

keyClassAsString

keyModesOfUse

keyUsage

keyUsageAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields