java.lang.Object
- software.amazon.awssdk.services.paymentcryptographydata.model.EcdhDerivationAttributes

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<EcdhDerivationAttributes.Builder,EcdhDerivationAttributes>

@Generated("software.amazon.awssdk:codegen")
public final class EcdhDerivationAttributes
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<EcdhDerivationAttributes.Builder,EcdhDerivationAttributes>

Parameters required to establish ECDH based key exchange.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface EcdhDerivationAttributes.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static EcdhDerivationAttributes.Builder`	`builder()`
`String`	`certificateAuthorityPublicKeyIdentifier()`	The `keyArn` of the certificate that signed the client's `PublicKeyCertificate`.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`SymmetricKeyAlgorithm`	`keyAlgorithm()`	The key algorithm of the derived ECDH key.
`String`	`keyAlgorithmAsString()`	The key algorithm of the derived ECDH key.
`KeyDerivationFunction`	`keyDerivationFunction()`	The key derivation function to use for deriving a key using ECDH.
`String`	`keyDerivationFunctionAsString()`	The key derivation function to use for deriving a key using ECDH.
`KeyDerivationHashAlgorithm`	`keyDerivationHashAlgorithm()`	The hash type to use for deriving a key using ECDH.
`String`	`keyDerivationHashAlgorithmAsString()`	The hash type to use for deriving a key using ECDH.
`String`	`publicKeyCertificate()`	The client's public key certificate in PEM format (base64 encoded) to use for ECDH key derivation.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends EcdhDerivationAttributes.Builder>`	`serializableBuilderClass()`
`String`	`sharedInformation()`	A byte string containing information that binds the ECDH derived key to the two parties involved or to the context of the key.
`EcdhDerivationAttributes.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
  - certificateAuthorityPublicKeyIdentifier
```
public final String certificateAuthorityPublicKeyIdentifier()
```
    The keyArn of the certificate that signed the client's PublicKeyCertificate.
    
    Returns:
    
    The keyArn of the certificate that signed the client's PublicKeyCertificate.
  - publicKeyCertificate
```
public final String publicKeyCertificate()
```
    The client's public key certificate in PEM format (base64 encoded) to use for ECDH key derivation.
    
    Returns:
    
    The client's public key certificate in PEM format (base64 encoded) to use for ECDH key derivation.
  - keyAlgorithm
```
public final SymmetricKeyAlgorithm keyAlgorithm()
```
    The key algorithm of the derived ECDH key.
    
    If the service returns an enum value that is not available in the current SDK version, keyAlgorithm will return SymmetricKeyAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyAlgorithmAsString().
    
    Returns:
    
    The key algorithm of the derived ECDH key.
    
    See Also:
    
    SymmetricKeyAlgorithm
  - keyAlgorithmAsString
```
public final String keyAlgorithmAsString()
```
    The key algorithm of the derived ECDH key.
    
    If the service returns an enum value that is not available in the current SDK version, keyAlgorithm will return SymmetricKeyAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyAlgorithmAsString().
    
    Returns:
    
    The key algorithm of the derived ECDH key.
    
    See Also:
    
    SymmetricKeyAlgorithm
  - keyDerivationFunction
```
public final KeyDerivationFunction keyDerivationFunction()
```
    The key derivation function to use for deriving a key using ECDH.
    
    If the service returns an enum value that is not available in the current SDK version, keyDerivationFunction will return KeyDerivationFunction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyDerivationFunctionAsString().
    
    Returns:
    
    The key derivation function to use for deriving a key using ECDH.
    
    See Also:
    
    KeyDerivationFunction
  - keyDerivationFunctionAsString
```
public final String keyDerivationFunctionAsString()
```
    The key derivation function to use for deriving a key using ECDH.
    
    If the service returns an enum value that is not available in the current SDK version, keyDerivationFunction will return KeyDerivationFunction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyDerivationFunctionAsString().
    
    Returns:
    
    The key derivation function to use for deriving a key using ECDH.
    
    See Also:
    
    KeyDerivationFunction
  - keyDerivationHashAlgorithm
```
public final KeyDerivationHashAlgorithm keyDerivationHashAlgorithm()
```
    The hash type to use for deriving a key using ECDH.
    
    If the service returns an enum value that is not available in the current SDK version, keyDerivationHashAlgorithm will return KeyDerivationHashAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyDerivationHashAlgorithmAsString().
    
    Returns:
    
    The hash type to use for deriving a key using ECDH.
    
    See Also:
    
    KeyDerivationHashAlgorithm
  - keyDerivationHashAlgorithmAsString
```
public final String keyDerivationHashAlgorithmAsString()
```
    The hash type to use for deriving a key using ECDH.
    
    If the service returns an enum value that is not available in the current SDK version, keyDerivationHashAlgorithm will return KeyDerivationHashAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyDerivationHashAlgorithmAsString().
    
    Returns:
    
    The hash type to use for deriving a key using ECDH.
    
    See Also:
    
    KeyDerivationHashAlgorithm
  - sharedInformation
```
public final String sharedInformation()
```
    A byte string containing information that binds the ECDH derived key to the two parties involved or to the context of the key.
    
    It may include details like identities of the two parties deriving the key, context of the operation, session IDs, and optionally a nonce. It must not contain zero bytes, and re-using shared information for multiple ECDH key derivations is not recommended.
    
    Returns:
    
    A byte string containing information that binds the ECDH derived key to the two parties involved or to the context of the key.
    
    It may include details like identities of the two parties deriving the key, context of the operation, session IDs, and optionally a nonce. It must not contain zero bytes, and re-using shared information for multiple ECDH key derivations is not recommended.
  - toBuilder
```
public EcdhDerivationAttributes.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<EcdhDerivationAttributes.Builder,EcdhDerivationAttributes>
  - builder
```
public static EcdhDerivationAttributes.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends EcdhDerivationAttributes.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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class EcdhDerivationAttributes

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

certificateAuthorityPublicKeyIdentifier

publicKeyCertificate

keyAlgorithm

keyAlgorithmAsString

keyDerivationFunction

keyDerivationFunctionAsString

keyDerivationHashAlgorithm

keyDerivationHashAlgorithmAsString

sharedInformation

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField