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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<WrappedKey.Builder,WrappedKey>
```
@Generated("software.amazon.awssdk:codegen")
public final class WrappedKey
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<WrappedKey.Builder,WrappedKey>
```
Parameter information for generating a WrappedKeyBlock for key exchange.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface WrappedKey.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static WrappedKey.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`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).
`String`	`keyMaterial()`	Parameter information for generating a wrapped key using TR-31 or TR-34 skey exchange method.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends WrappedKey.Builder>`	`serializableBuilderClass()`
`WrappedKey.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`WrappedKeyMaterialFormat`	`wrappedKeyMaterialFormat()`	The key block format of a wrapped key.
`String`	`wrappedKeyMaterialFormatAsString()`	The key block format of a wrapped key.
`String`	`wrappingKeyArn()`	The `KeyARN` of the wrapped key.

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
  - 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
  - keyMaterial
```
public final String keyMaterial()
```
    Parameter information for generating a wrapped key using TR-31 or TR-34 skey exchange method.
    
    Returns:
    
    Parameter information for generating a wrapped key using TR-31 or TR-34 skey exchange method.
  - wrappedKeyMaterialFormat
```
public final WrappedKeyMaterialFormat wrappedKeyMaterialFormat()
```
    The key block format of a wrapped key.
    
    If the service returns an enum value that is not available in the current SDK version, wrappedKeyMaterialFormat will return WrappedKeyMaterialFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from wrappedKeyMaterialFormatAsString().
    
    Returns:
    
    The key block format of a wrapped key.
    
    See Also:
    
    WrappedKeyMaterialFormat
  - wrappedKeyMaterialFormatAsString
```
public final String wrappedKeyMaterialFormatAsString()
```
    The key block format of a wrapped key.
    
    If the service returns an enum value that is not available in the current SDK version, wrappedKeyMaterialFormat will return WrappedKeyMaterialFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from wrappedKeyMaterialFormatAsString().
    
    Returns:
    
    The key block format of a wrapped key.
    
    See Also:
    
    WrappedKeyMaterialFormat
  - wrappingKeyArn
```
public final String wrappingKeyArn()
```
    The KeyARN of the wrapped key.
    
    Returns:
    
    The KeyARN of the wrapped key.
  - toBuilder
```
public WrappedKey.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<WrappedKey.Builder,WrappedKey>
  - builder
```
public static WrappedKey.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends WrappedKey.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 WrappedKey

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

keyCheckValue

keyCheckValueAlgorithm

keyCheckValueAlgorithmAsString

keyMaterial

wrappedKeyMaterialFormat

wrappedKeyMaterialFormatAsString

wrappingKeyArn

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields