com.amazonaws.services.kms.model

Class DecryptResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.kms.model.DecryptResult

All Implemented Interfaces:

Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DecryptResult()

Method Summary

Modifier and Type	Method and Description
DecryptResult	clone()
boolean	equals(Object obj)
String	getEncryptionAlgorithm() The encryption algorithm that was used to decrypt the ciphertext.
String	getKeyId() The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.
ByteBuffer	getPlaintext() Decrypted plaintext data.
int	hashCode()
void	setEncryptionAlgorithm(String encryptionAlgorithm) The encryption algorithm that was used to decrypt the ciphertext.
void	setKeyId(String keyId) The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.
void	setPlaintext(ByteBuffer plaintext) Decrypted plaintext data.
String	toString() Returns a string representation of this object.
DecryptResult	withEncryptionAlgorithm(EncryptionAlgorithmSpec encryptionAlgorithm) The encryption algorithm that was used to decrypt the ciphertext.
DecryptResult	withEncryptionAlgorithm(String encryptionAlgorithm) The encryption algorithm that was used to decrypt the ciphertext.
DecryptResult	withKeyId(String keyId) The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.
DecryptResult	withPlaintext(ByteBuffer plaintext) Decrypted plaintext data.

Methods inherited from class com.amazonaws.AmazonWebServiceResult

getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DecryptResult

public DecryptResult()

Method Detail

setKeyId

public void setKeyId(String keyId)

The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.

Parameters:

keyId - The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.

getKeyId

public String getKeyId()

The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.

Returns:

The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.

withKeyId

public DecryptResult withKeyId(String keyId)

The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.

Parameters:

keyId - The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.

Returns:

Returns a reference to this object so that method calls can be chained together.

setPlaintext

public void setPlaintext(ByteBuffer plaintext)

Decrypted plaintext data. When you use the HTTP API or the AWS 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:

plaintext - Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

getPlaintext

public ByteBuffer getPlaintext()

Decrypted plaintext data. When you use the HTTP API or the AWS 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:

Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

withPlaintext

public DecryptResult withPlaintext(ByteBuffer plaintext)

Decrypted plaintext data. When you use the HTTP API or the AWS 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:

plaintext - Decrypted plaintext data. When you use the HTTP API or the AWS 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.

setEncryptionAlgorithm

public void setEncryptionAlgorithm(String encryptionAlgorithm)

The encryption algorithm that was used to decrypt the ciphertext.

Parameters:

encryptionAlgorithm - The encryption algorithm that was used to decrypt the ciphertext.

See Also:

EncryptionAlgorithmSpec

getEncryptionAlgorithm

public String getEncryptionAlgorithm()

The encryption algorithm that was used to decrypt the ciphertext.

Returns:

The encryption algorithm that was used to decrypt the ciphertext.

See Also:

EncryptionAlgorithmSpec

withEncryptionAlgorithm

public DecryptResult withEncryptionAlgorithm(String encryptionAlgorithm)

The encryption algorithm that was used to decrypt the ciphertext.

Parameters:

encryptionAlgorithm - The encryption algorithm that was used to decrypt the ciphertext.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EncryptionAlgorithmSpec

withEncryptionAlgorithm

public DecryptResult withEncryptionAlgorithm(EncryptionAlgorithmSpec encryptionAlgorithm)

The encryption algorithm that was used to decrypt the ciphertext.

Parameters:

encryptionAlgorithm - The encryption algorithm that was used to decrypt the ciphertext.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EncryptionAlgorithmSpec

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 DecryptResult clone()

Overrides:

clone in class Object