DecryptRequest (AWS SDK for Android

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.kms.model.DecryptRequest

All Implemented Interfaces:

Serializable, Cloneable
```
public class DecryptRequest
extends AmazonWebServiceRequest
implements Serializable
```
Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following operations:
Whenever possible, use key policies to give users permission to call the Decrypt operation on the CMK, instead of IAM policies. Otherwise, you might create an IAM user policy that gives the user Decrypt permission on all CMKs. This user could decrypt ciphertext that was encrypted by CMKs in other accounts if the key policy for the cross-account CMK permits it. If you must use an IAM policy for Decrypt permissions, limit the user to particular CMKs or particular trusted accounts.

The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

DecryptRequest()

Constructors
Constructor and Description
`DecryptRequest()`

Method Summary

All Methods Instance Methods Concrete 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 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
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

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

- Constructor Detail
  - DecryptRequest
```
public DecryptRequest()
```
- Method Detail
  - getCiphertextBlob
```
public ByteBuffer getCiphertextBlob()
```
    Ciphertext to be decrypted. The blob includes metadata.
    
    Constraints:
    Length: 1 - 6144
    
    Returns:
    
    Ciphertext to be decrypted. The blob includes metadata.
  - setCiphertextBlob
```
public void setCiphertextBlob(ByteBuffer ciphertextBlob)
```
    Ciphertext to be decrypted. The blob includes metadata.
    
    Constraints:
    Length: 1 - 6144
    
    Parameters:
    
    ciphertextBlob -
    Ciphertext to be decrypted. The blob includes metadata.
  - withCiphertextBlob
```
public DecryptRequest withCiphertextBlob(ByteBuffer ciphertextBlob)
```
    Ciphertext to be decrypted. The blob includes metadata.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 6144
    
    Parameters:
    
    ciphertextBlob -
    Ciphertext to be decrypted. The blob includes 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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - 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.
    
    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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    grantTokens -
    A list of grant tokens.
    
    For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
    
    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.
    
    For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    grantTokens -
    A list of grant tokens.
    
    For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
    
    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

Class DecryptRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

DecryptRequest

Method Detail

getCiphertextBlob

setCiphertextBlob

withCiphertextBlob

getEncryptionContext

setEncryptionContext

withEncryptionContext

addEncryptionContextEntry

clearEncryptionContextEntries

getGrantTokens

setGrantTokens

withGrantTokens

withGrantTokens

toString

hashCode

equals