com.amazonaws.services.kms.model

Class DecryptRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kms.model.DecryptRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DecryptRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DecryptRequest()

Method Summary

Modifier and Type	Method and Description
DecryptRequest	addEncryptionContextEntry(String key, String value)
DecryptRequest	clearEncryptionContextEntries() Removes all the entries added into EncryptionContext.
DecryptRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
ByteBuffer	getCiphertextBlob() Ciphertext to be decrypted.
Map<String,String>	getEncryptionContext() The encryption context.
List<String>	getGrantTokens() A list of grant tokens.
int	hashCode()
void	setCiphertextBlob(ByteBuffer ciphertextBlob) Ciphertext to be decrypted.
void	setEncryptionContext(Map<String,String> encryptionContext) The encryption context.
void	setGrantTokens(Collection<String> grantTokens) A list of grant tokens.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DecryptRequest	withCiphertextBlob(ByteBuffer ciphertextBlob) Ciphertext to be decrypted.
DecryptRequest	withEncryptionContext(Map<String,String> encryptionContext) The encryption context.
DecryptRequest	withGrantTokens(Collection<String> grantTokens) A list of grant tokens.
DecryptRequest	withGrantTokens(String... grantTokens) A list of grant tokens.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DecryptRequest

public DecryptRequest()

Method Detail

setCiphertextBlob

public void setCiphertextBlob(ByteBuffer ciphertextBlob)

Ciphertext to be decrypted. The blob includes metadata.

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 - Ciphertext to be decrypted. The blob includes metadata.

getCiphertextBlob

public ByteBuffer getCiphertextBlob()

Ciphertext to be decrypted. The blob includes metadata.

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:

Ciphertext to be decrypted. The blob includes metadata.

withCiphertextBlob

public DecryptRequest withCiphertextBlob(ByteBuffer ciphertextBlob)

Ciphertext to be decrypted. The blob includes metadata.

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 - Ciphertext to be decrypted. The blob includes metadata.

Returns:

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

getEncryptionContext

public Map<String,String> getEncryptionContext()

The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.

Returns:

The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.

setEncryptionContext

public void setEncryptionContext(Map<String,String> encryptionContext)

The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.

Parameters:

encryptionContext - The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.

withEncryptionContext

public DecryptRequest withEncryptionContext(Map<String,String> encryptionContext)

The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.

Parameters:

encryptionContext - The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.

Returns:

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

addEncryptionContextEntry

public DecryptRequest addEncryptionContextEntry(String key,
                                                String value)

clearEncryptionContextEntries

public DecryptRequest clearEncryptionContextEntries()

Removes all the entries added into EncryptionContext.

Returns:

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

getGrantTokens

public List<String> getGrantTokens()

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Returns:

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

setGrantTokens

public void setGrantTokens(Collection<String> grantTokens)

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Parameters:

grantTokens - A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

withGrantTokens

public DecryptRequest withGrantTokens(String... grantTokens)

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

NOTE: This method appends the values to the existing list (if any). Use setGrantTokens(java.util.Collection) or withGrantTokens(java.util.Collection) if you want to override the existing values.

Parameters:

grantTokens - A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Returns:

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

withGrantTokens

public DecryptRequest withGrantTokens(Collection<String> grantTokens)

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Parameters:

grantTokens - A list of grant tokens.

For more information, see Grant Tokens in the AWS 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; useful for testing and debugging.

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

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()