Class DecryptRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.kms.model.DecryptRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable

public class DecryptRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
See Also:
  • Constructor Details

    • DecryptRequest

      public DecryptRequest()
  • Method Details

    • setCiphertextBlob

      public void setCiphertextBlob(ByteBuffer ciphertextBlob)

      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

      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.

      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. <p> 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:
    • 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 request. Explicitly does not clone the deep structure of the request object.
      Overrides:
      clone in class AmazonWebServiceRequest
      See Also: