RecipientInfo (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.kms.model.RecipientInfo

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RecipientInfo
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contains information about the party that receives the response from the API operation.

This data type is designed to support Amazon Web Services Nitro Enclaves, which lets you create an isolated compute environment in Amazon EC2. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

RecipientInfo()

Constructors
Constructor and Description
`RecipientInfo()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RecipientInfo`	`clone()`
`boolean`	`equals(Object obj)`
`ByteBuffer`	`getAttestationDocument()` The attestation document for an Amazon Web Services Nitro Enclave.
`String`	`getKeyEncryptionAlgorithm()` The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro Enclave to encrypt plaintext values for the response.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAttestationDocument(ByteBuffer attestationDocument)` The attestation document for an Amazon Web Services Nitro Enclave.
`void`	`setKeyEncryptionAlgorithm(String keyEncryptionAlgorithm)` The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro Enclave to encrypt plaintext values for the response.
`String`	`toString()` Returns a string representation of this object.
`RecipientInfo`	`withAttestationDocument(ByteBuffer attestationDocument)` The attestation document for an Amazon Web Services Nitro Enclave.
`RecipientInfo`	`withKeyEncryptionAlgorithm(KeyEncryptionMechanism keyEncryptionAlgorithm)` The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro Enclave to encrypt plaintext values for the response.
`RecipientInfo`	`withKeyEncryptionAlgorithm(String keyEncryptionAlgorithm)` The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro Enclave to encrypt plaintext values for the response.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RecipientInfo
```
public RecipientInfo()
```
- Method Detail
  - setKeyEncryptionAlgorithm
```
public void setKeyEncryptionAlgorithm(String keyEncryptionAlgorithm)
```
    The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro Enclave to encrypt plaintext values for the response. The only valid value is RSAES_OAEP_SHA_256.
    
    Parameters:
    
    keyEncryptionAlgorithm - The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro Enclave to encrypt plaintext values for the response. The only valid value is RSAES_OAEP_SHA_256.
    
    See Also:
    
    KeyEncryptionMechanism
  - getKeyEncryptionAlgorithm
```
public String getKeyEncryptionAlgorithm()
```
    The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro Enclave to encrypt plaintext values for the response. The only valid value is RSAES_OAEP_SHA_256.
    
    Returns:
    
    The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro Enclave to encrypt plaintext values for the response. The only valid value is RSAES_OAEP_SHA_256.
    
    See Also:
    
    KeyEncryptionMechanism
  - withKeyEncryptionAlgorithm
```
public RecipientInfo withKeyEncryptionAlgorithm(String keyEncryptionAlgorithm)
```
    The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro Enclave to encrypt plaintext values for the response. The only valid value is RSAES_OAEP_SHA_256.
    
    Parameters:
    
    keyEncryptionAlgorithm - The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro Enclave to encrypt plaintext values for the response. The only valid value is RSAES_OAEP_SHA_256.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KeyEncryptionMechanism
  - withKeyEncryptionAlgorithm
```
public RecipientInfo withKeyEncryptionAlgorithm(KeyEncryptionMechanism keyEncryptionAlgorithm)
```
    The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro Enclave to encrypt plaintext values for the response. The only valid value is RSAES_OAEP_SHA_256.
    
    Parameters:
    
    keyEncryptionAlgorithm - The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro Enclave to encrypt plaintext values for the response. The only valid value is RSAES_OAEP_SHA_256.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KeyEncryptionMechanism
  - setAttestationDocument
```
public void setAttestationDocument(ByteBuffer attestationDocument)
```
    The attestation document for an Amazon Web Services Nitro Enclave. This document includes the enclave's public key.
    
    The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
    
    Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.
    
    Parameters:
    
    attestationDocument - The attestation document for an Amazon Web Services Nitro Enclave. This document includes the enclave's public key.
  - getAttestationDocument
```
public ByteBuffer getAttestationDocument()
```
    The attestation document for an Amazon Web Services Nitro Enclave. This document includes the enclave's public key.
    
    ByteBuffers are stateful. Calling their get methods changes their position. We recommend using ByteBuffer.asReadOnlyBuffer() to create a read-only view of the buffer with an independent position, and calling get methods on this rather than directly on the returned ByteBuffer. Doing so will ensure that anyone else using the ByteBuffer will not be affected by changes to the position.
    
    Returns:
    
    The attestation document for an Amazon Web Services Nitro Enclave. This document includes the enclave's public key.
  - withAttestationDocument
```
public RecipientInfo withAttestationDocument(ByteBuffer attestationDocument)
```
    The attestation document for an Amazon Web Services Nitro Enclave. This document includes the enclave's public key.
    
    The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
    
    Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.
    
    Parameters:
    
    attestationDocument - The attestation document for an Amazon Web Services Nitro Enclave. This document includes the enclave's public key.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public RecipientInfo clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.772

Class RecipientInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RecipientInfo

Method Detail

setKeyEncryptionAlgorithm

getKeyEncryptionAlgorithm

withKeyEncryptionAlgorithm

withKeyEncryptionAlgorithm

setAttestationDocument

getAttestationDocument

withAttestationDocument

toString

equals

hashCode

clone

marshall