Class DecryptRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddEncryptionContextEntry
(String key, String value) Removes all the entries added into EncryptionContext.clone()
Creates a shallow clone of this request.boolean
Ciphertext to be decrypted.The encryption context.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.toString()
Returns a string representation of this object; useful for testing and debugging.withCiphertextBlob
(ByteBuffer ciphertextBlob) Ciphertext to be decrypted.withEncryptionContext
(Map<String, String> encryptionContext) The encryption context.withGrantTokens
(String... grantTokens) A list of grant tokens.withGrantTokens
(Collection<String> grantTokens) A list of grant tokens.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
DecryptRequest
public DecryptRequest()
-
-
Method Details
-
setCiphertextBlob
Ciphertext to be decrypted. The blob includes metadata.
AWS SDK for Java performs a Base64 encoding on this field before sending this request to AWS service by default. 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
Ciphertext to be decrypted. The blob includes metadata.
ByteBuffer
s are stateful. Calling theirget
methods changes theirposition
. We recommend usingByteBuffer.asReadOnlyBuffer()
to create a read-only view of the buffer with an independentposition
, and callingget
methods on this rather than directly on the returnedByteBuffer
. Doing so will ensure that anyone else using theByteBuffer
will not be affected by changes to theposition
.- Returns:
- Ciphertext to be decrypted. The blob includes metadata.
-
withCiphertextBlob
Ciphertext to be decrypted. The blob includes metadata.
- 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
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
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
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
-
clearEncryptionContextEntries
Removes all the entries added into EncryptionContext. <p> Returns a reference to this object so that method calls can be chained together. -
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
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
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)
orwithGrantTokens(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
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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-