com.amazonaws.services.kms.model

Class EncryptResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.kms.model.EncryptResult

All Implemented Interfaces:

Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
EncryptResult()

Method Summary

Modifier and Type	Method and Description
EncryptResult	clone()
boolean	equals(Object obj)
ByteBuffer	getCiphertextBlob() The encrypted plaintext.
String	getEncryptionAlgorithm() The encryption algorithm that was used to encrypt the plaintext.
String	getKeyId() The Amazon Resource Name (key ARN) of the KMS key that was used to encrypt the plaintext.
int	hashCode()
void	setCiphertextBlob(ByteBuffer ciphertextBlob) The encrypted plaintext.
void	setEncryptionAlgorithm(String encryptionAlgorithm) The encryption algorithm that was used to encrypt the plaintext.
void	setKeyId(String keyId) The Amazon Resource Name (key ARN) of the KMS key that was used to encrypt the plaintext.
String	toString() Returns a string representation of this object.
EncryptResult	withCiphertextBlob(ByteBuffer ciphertextBlob) The encrypted plaintext.
EncryptResult	withEncryptionAlgorithm(EncryptionAlgorithmSpec encryptionAlgorithm) The encryption algorithm that was used to encrypt the plaintext.
EncryptResult	withEncryptionAlgorithm(String encryptionAlgorithm) The encryption algorithm that was used to encrypt the plaintext.
EncryptResult	withKeyId(String keyId) The Amazon Resource Name (key ARN) of the KMS key that was used to encrypt the plaintext.

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

EncryptResult

public EncryptResult()

Method Detail

setCiphertextBlob

public void setCiphertextBlob(ByteBuffer ciphertextBlob)

The encrypted plaintext. 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 plaintext. 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 plaintext. 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 plaintext. 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 EncryptResult withCiphertextBlob(ByteBuffer ciphertextBlob)

The encrypted plaintext. 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 plaintext. 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.

setKeyId

public void setKeyId(String keyId)

The Amazon Resource Name (key ARN) of the KMS key that was used to encrypt the plaintext.

Parameters:

keyId - The Amazon Resource Name (key ARN) of the KMS key that was used to encrypt the plaintext.

getKeyId

public String getKeyId()

The Amazon Resource Name (key ARN) of the KMS key that was used to encrypt the plaintext.

Returns:

The Amazon Resource Name (key ARN) of the KMS key that was used to encrypt the plaintext.

withKeyId

public EncryptResult withKeyId(String keyId)

The Amazon Resource Name (key ARN) of the KMS key that was used to encrypt the plaintext.

Parameters:

keyId - The Amazon Resource Name (key ARN) of the KMS key that was used to encrypt the plaintext.

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 encrypt the plaintext.

Parameters:

encryptionAlgorithm - The encryption algorithm that was used to encrypt the plaintext.

See Also:

EncryptionAlgorithmSpec

getEncryptionAlgorithm

public String getEncryptionAlgorithm()

The encryption algorithm that was used to encrypt the plaintext.

Returns:

The encryption algorithm that was used to encrypt the plaintext.

See Also:

EncryptionAlgorithmSpec

withEncryptionAlgorithm

public EncryptResult withEncryptionAlgorithm(String encryptionAlgorithm)

The encryption algorithm that was used to encrypt the plaintext.

Parameters:

encryptionAlgorithm - The encryption algorithm that was used to encrypt the plaintext.

Returns:

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

See Also:

EncryptionAlgorithmSpec

withEncryptionAlgorithm

public EncryptResult withEncryptionAlgorithm(EncryptionAlgorithmSpec encryptionAlgorithm)

The encryption algorithm that was used to encrypt the plaintext.

Parameters:

encryptionAlgorithm - The encryption algorithm that was used to encrypt the plaintext.

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

Overrides:

clone in class Object