com.amazonaws.services.kms.model

Class DecryptRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kms.model.DecryptRequest

All Implemented Interfaces:

Serializable

public class DecryptRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the Decrypt operation.

Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using the Encrypt function.

See Also:

AWSKMS.decrypt(DecryptRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DecryptRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DecryptRequest	addEncryptionContextEntry(String key, String value) The encryption context.
DecryptRequest	clearEncryptionContextEntries() Removes all the entries added into EncryptionContext.
boolean	equals(Object obj)
ByteBuffer	getCiphertextBlob() Ciphertext including metadata.
Map<String,String>	getEncryptionContext() The encryption context.
List<String>	getGrantTokens() A list of grant tokens that represent grants which can be used to provide long term permissions to perform decryption.
int	hashCode()
void	setCiphertextBlob(ByteBuffer ciphertextBlob) Ciphertext including metadata.
void	setEncryptionContext(Map<String,String> encryptionContext) The encryption context.
void	setGrantTokens(Collection<String> grantTokens) A list of grant tokens that represent grants which can be used to provide long term permissions to perform decryption.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DecryptRequest	withCiphertextBlob(ByteBuffer ciphertextBlob) Ciphertext including metadata.
DecryptRequest	withEncryptionContext(Map<String,String> encryptionContext) The encryption context.
DecryptRequest	withGrantTokens(Collection<String> grantTokens) A list of grant tokens that represent grants which can be used to provide long term permissions to perform decryption.
DecryptRequest	withGrantTokens(String... grantTokens) A list of grant tokens that represent grants which can be used to provide long term permissions to perform decryption.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

DecryptRequest

public DecryptRequest()

Method Detail

getCiphertextBlob

public ByteBuffer getCiphertextBlob()

Ciphertext including metadata.

Constraints:
Length: 1 - 6144

Returns:

Ciphertext including metadata.

setCiphertextBlob

public void setCiphertextBlob(ByteBuffer ciphertextBlob)

Ciphertext including metadata.

Constraints:
Length: 1 - 6144

Parameters:

ciphertextBlob - Ciphertext including metadata.

withCiphertextBlob

public DecryptRequest withCiphertextBlob(ByteBuffer ciphertextBlob)

Ciphertext including metadata.

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

Constraints:
Length: 1 - 6144

Parameters:

ciphertextBlob - Ciphertext including metadata.

Returns:

A reference to this updated 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.

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

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:

A reference to this updated object so that method calls can be chained together.

addEncryptionContextEntry

public DecryptRequest addEncryptionContextEntry(String key,
                                       String value)

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.

The method adds a new key-value pair into EncryptionContext parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into EncryptionContext.

value - The corresponding value of the entry to be added into EncryptionContext.

clearEncryptionContextEntries

public DecryptRequest clearEncryptionContextEntries()

Removes all the entries added into EncryptionContext.

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

getGrantTokens

public List<String> getGrantTokens()

A list of grant tokens that represent grants which can be used to provide long term permissions to perform decryption.

Constraints:
Length: 0 - 10

Returns:

A list of grant tokens that represent grants which can be used to provide long term permissions to perform decryption.

setGrantTokens

public void setGrantTokens(Collection<String> grantTokens)

A list of grant tokens that represent grants which can be used to provide long term permissions to perform decryption.

Constraints:
Length: 0 - 10

Parameters:

grantTokens - A list of grant tokens that represent grants which can be used to provide long term permissions to perform decryption.

withGrantTokens

public DecryptRequest withGrantTokens(String... grantTokens)

A list of grant tokens that represent grants which can be used to provide long term permissions to perform decryption.

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

Constraints:
Length: 0 - 10

Parameters:

grantTokens - A list of grant tokens that represent grants which can be used to provide long term permissions to perform decryption.

Returns:

A reference to this updated object so that method calls can be chained together.

withGrantTokens

public DecryptRequest withGrantTokens(Collection<String> grantTokens)

A list of grant tokens that represent grants which can be used to provide long term permissions to perform decryption.

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

Constraints:
Length: 0 - 10

Parameters:

grantTokens - A list of grant tokens that represent grants which can be used to provide long term permissions to perform decryption.

Returns:

A reference to this updated 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()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object