GenerateDataKeyResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.kms.model.GenerateDataKeyResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GenerateDataKeyResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

GenerateDataKeyResult()

Constructors
Constructor and Description
`GenerateDataKeyResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GenerateDataKeyResult`	`clone()`
`boolean`	`equals(Object obj)`
`ByteBuffer`	`getCiphertextBlob()` The encrypted copy of the data key.
`ByteBuffer`	`getCiphertextForRecipient()` The plaintext data key encrypted with the public key from the Nitro enclave.
`String`	`getKeyId()` The Amazon Resource Name (key ARN) of the KMS key that encrypted the data key.
`ByteBuffer`	`getPlaintext()` The plaintext data key.
`int`	`hashCode()`
`void`	`setCiphertextBlob(ByteBuffer ciphertextBlob)` The encrypted copy of the data key.
`void`	`setCiphertextForRecipient(ByteBuffer ciphertextForRecipient)` The plaintext data key encrypted with the public key from the Nitro enclave.
`void`	`setKeyId(String keyId)` The Amazon Resource Name (key ARN) of the KMS key that encrypted the data key.
`void`	`setPlaintext(ByteBuffer plaintext)` The plaintext data key.
`String`	`toString()` Returns a string representation of this object.
`GenerateDataKeyResult`	`withCiphertextBlob(ByteBuffer ciphertextBlob)` The encrypted copy of the data key.
`GenerateDataKeyResult`	`withCiphertextForRecipient(ByteBuffer ciphertextForRecipient)` The plaintext data key encrypted with the public key from the Nitro enclave.
`GenerateDataKeyResult`	`withKeyId(String keyId)` The Amazon Resource Name (key ARN) of the KMS key that encrypted the data key.
`GenerateDataKeyResult`	`withPlaintext(ByteBuffer plaintext)` The plaintext data key.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

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

- Constructor Detail
  - GenerateDataKeyResult
```
public GenerateDataKeyResult()
```
- Method Detail
  - setCiphertextBlob
```
public void setCiphertextBlob(ByteBuffer ciphertextBlob)
```
    The encrypted copy of the data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
    
    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:
    
    ciphertextBlob - The encrypted copy of the data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
  - getCiphertextBlob
```
public ByteBuffer getCiphertextBlob()
```
    The encrypted copy of the data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
    
    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 encrypted copy of the data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
  - withCiphertextBlob
```
public GenerateDataKeyResult withCiphertextBlob(ByteBuffer ciphertextBlob)
```
    The encrypted copy of the data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
    
    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:
    
    ciphertextBlob - The encrypted copy of the data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPlaintext
```
public void setPlaintext(ByteBuffer plaintext)
```
    The plaintext data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. Use this data key to encrypt your data outside of KMS. Then, remove it from memory as soon as possible.
    
    If the response includes the CiphertextForRecipient field, the Plaintext field is null or empty.
    
    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:
    
    plaintext - The plaintext data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. Use this data key to encrypt your data outside of KMS. Then, remove it from memory as soon as possible.
    
    If the response includes the CiphertextForRecipient field, the Plaintext field is null or empty.
  - getPlaintext
```
public ByteBuffer getPlaintext()
```
    The plaintext data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. Use this data key to encrypt your data outside of KMS. Then, remove it from memory as soon as possible.
    
    If the response includes the CiphertextForRecipient field, the Plaintext field is null or empty.
    
    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 plaintext data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. Use this data key to encrypt your data outside of KMS. Then, remove it from memory as soon as possible.
    
    If the response includes the CiphertextForRecipient field, the Plaintext field is null or empty.
  - withPlaintext
```
public GenerateDataKeyResult withPlaintext(ByteBuffer plaintext)
```
    The plaintext data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. Use this data key to encrypt your data outside of KMS. Then, remove it from memory as soon as possible.
    
    If the response includes the CiphertextForRecipient field, the Plaintext field is null or empty.
    
    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:
    
    plaintext - The plaintext data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. Use this data key to encrypt your data outside of KMS. Then, remove it from memory as soon as possible.
    
    If the response includes the CiphertextForRecipient field, the Plaintext field is null or empty.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKeyId
```
public void setKeyId(String keyId)
```
    The Amazon Resource Name (key ARN) of the KMS key that encrypted the data key.
    
    Parameters:
    
    keyId - The Amazon Resource Name (key ARN) of the KMS key that encrypted the data key.
  - getKeyId
```
public String getKeyId()
```
    The Amazon Resource Name (key ARN) of the KMS key that encrypted the data key.
    
    Returns:
    
    The Amazon Resource Name (key ARN) of the KMS key that encrypted the data key.
  - withKeyId
```
public GenerateDataKeyResult withKeyId(String keyId)
```
    The Amazon Resource Name (key ARN) of the KMS key that encrypted the data key.
    
    Parameters:
    
    keyId - The Amazon Resource Name (key ARN) of the KMS key that encrypted the data key.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCiphertextForRecipient
```
public void setCiphertextForRecipient(ByteBuffer ciphertextForRecipient)
```
    The plaintext data key encrypted with the public key from the Nitro enclave. This ciphertext can be decrypted only by using a private key in the Nitro enclave.
    
    This field is included in the response only when the Recipient parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave. 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.
    
    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:
    
    ciphertextForRecipient - The plaintext data key encrypted with the public key from the Nitro enclave. This ciphertext can be decrypted only by using a private key in the Nitro enclave.
    
    This field is included in the response only when the Recipient parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave. 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.
  - getCiphertextForRecipient
```
public ByteBuffer getCiphertextForRecipient()
```
    The plaintext data key encrypted with the public key from the Nitro enclave. This ciphertext can be decrypted only by using a private key in the Nitro enclave.
    
    This field is included in the response only when the Recipient parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave. 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.
    
    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 plaintext data key encrypted with the public key from the Nitro enclave. This ciphertext can be decrypted only by using a private key in the Nitro enclave.
    
    This field is included in the response only when the Recipient parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave. 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.
  - withCiphertextForRecipient
```
public GenerateDataKeyResult withCiphertextForRecipient(ByteBuffer ciphertextForRecipient)
```
    The plaintext data key encrypted with the public key from the Nitro enclave. This ciphertext can be decrypted only by using a private key in the Nitro enclave.
    
    This field is included in the response only when the Recipient parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave. 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.
    
    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:
    
    ciphertextForRecipient - The plaintext data key encrypted with the public key from the Nitro enclave. This ciphertext can be decrypted only by using a private key in the Nitro enclave.
    
    This field is included in the response only when the Recipient parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave. 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.
    
    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 GenerateDataKeyResult clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.639

Class GenerateDataKeyResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

GenerateDataKeyResult

Method Detail

setCiphertextBlob

getCiphertextBlob

withCiphertextBlob

setPlaintext

getPlaintext

withPlaintext

setKeyId

getKeyId

withKeyId

setCiphertextForRecipient

getCiphertextForRecipient

withCiphertextForRecipient

toString

equals

hashCode

clone