Class KeyAttributes
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic KeyAttributes.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final KeyAlgorithm
The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.final String
The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.final KeyClass
keyClass()
The type of Amazon Web Services Payment Cryptography key to create, which determines the classification of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.final String
The type of Amazon Web Services Payment Cryptography key to create, which determines the classification of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.final KeyModesOfUse
The list of cryptographic operations that you can perform using the key.final KeyUsage
keyUsage()
The cryptographic usage of an Amazon Web Services Payment Cryptography key as defined in section A.5.2 of the TR-31 spec.final String
The cryptographic usage of an Amazon Web Services Payment Cryptography key as defined in section A.5.2 of the TR-31 spec.static Class
<? extends KeyAttributes.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
keyUsage
The cryptographic usage of an Amazon Web Services Payment Cryptography key as defined 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 returnKeyUsage.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromkeyUsageAsString()
.- Returns:
- The cryptographic usage of an Amazon Web Services Payment Cryptography key as defined in section A.5.2 of the TR-31 spec.
- See Also:
-
keyUsageAsString
The cryptographic usage of an Amazon Web Services Payment Cryptography key as defined 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 returnKeyUsage.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromkeyUsageAsString()
.- Returns:
- The cryptographic usage of an Amazon Web Services Payment Cryptography key as defined in section A.5.2 of the TR-31 spec.
- See Also:
-
keyClass
The type of Amazon Web Services Payment Cryptography key to create, which determines the classification 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 returnKeyClass.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromkeyClassAsString()
.- Returns:
- The type of Amazon Web Services Payment Cryptography key to create, which determines the classification of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.
- See Also:
-
keyClassAsString
The type of Amazon Web Services Payment Cryptography key to create, which determines the classification 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 returnKeyClass.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromkeyClassAsString()
.- Returns:
- The type of Amazon Web Services Payment Cryptography key to create, which determines the classification of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.
- See Also:
-
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
andTDES
algorithms. For asymmetric keys, Amazon Web Services Payment Cryptography supportsRSA
andECC_NIST
algorithms.If the service returns an enum value that is not available in the current SDK version,
keyAlgorithm
will returnKeyAlgorithm.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromkeyAlgorithmAsString()
.- 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
andTDES
algorithms. For asymmetric keys, Amazon Web Services Payment Cryptography supportsRSA
andECC_NIST
algorithms. - See Also:
-
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
andTDES
algorithms. For asymmetric keys, Amazon Web Services Payment Cryptography supportsRSA
andECC_NIST
algorithms.If the service returns an enum value that is not available in the current SDK version,
keyAlgorithm
will returnKeyAlgorithm.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromkeyAlgorithmAsString()
.- 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
andTDES
algorithms. For asymmetric keys, Amazon Web Services Payment Cryptography supportsRSA
andECC_NIST
algorithms. - See Also:
-
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.
-
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 interfaceToCopyableBuilder<KeyAttributes.Builder,
KeyAttributes> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-