DecryptResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.kms.model.DecryptResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DecryptResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DecryptResult()

Constructors
Constructor and Description
`DecryptResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DecryptResult`	`clone()`
`boolean`	`equals(Object obj)`
`ByteBuffer`	`getCiphertextForRecipient()` The plaintext data encrypted with the public key in the attestation document.
`String`	`getEncryptionAlgorithm()` The encryption algorithm that was used to decrypt the ciphertext.
`String`	`getKeyId()` The Amazon Resource Name (key ARN) of the KMS key that was used to decrypt the ciphertext.
`ByteBuffer`	`getPlaintext()` Decrypted plaintext data.
`int`	`hashCode()`
`void`	`setCiphertextForRecipient(ByteBuffer ciphertextForRecipient)` The plaintext data encrypted with the public key in the attestation document.
`void`	`setEncryptionAlgorithm(String encryptionAlgorithm)` The encryption algorithm that was used to decrypt the ciphertext.
`void`	`setKeyId(String keyId)` The Amazon Resource Name (key ARN) of the KMS key that was used to decrypt the ciphertext.
`void`	`setPlaintext(ByteBuffer plaintext)` Decrypted plaintext data.
`String`	`toString()` Returns a string representation of this object.
`DecryptResult`	`withCiphertextForRecipient(ByteBuffer ciphertextForRecipient)` The plaintext data encrypted with the public key in the attestation document.
`DecryptResult`	`withEncryptionAlgorithm(EncryptionAlgorithmSpec encryptionAlgorithm)` The encryption algorithm that was used to decrypt the ciphertext.
`DecryptResult`	`withEncryptionAlgorithm(String encryptionAlgorithm)` The encryption algorithm that was used to decrypt the ciphertext.
`DecryptResult`	`withKeyId(String keyId)` The Amazon Resource Name (key ARN) of the KMS key that was used to decrypt the ciphertext.
`DecryptResult`	`withPlaintext(ByteBuffer plaintext)` Decrypted plaintext data.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

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

- Constructor Detail
  - DecryptResult
```
public DecryptResult()
```
- Method Detail
  - setKeyId
```
public void setKeyId(String keyId)
```
    The Amazon Resource Name (key ARN) of the KMS key that was used to decrypt the ciphertext.
    
    Parameters:
    
    keyId - The Amazon Resource Name (key ARN) of the KMS key that was used to decrypt the ciphertext.
  - getKeyId
```
public String getKeyId()
```
    The Amazon Resource Name (key ARN) of the KMS key that was used to decrypt the ciphertext.
    
    Returns:
    
    The Amazon Resource Name (key ARN) of the KMS key that was used to decrypt the ciphertext.
  - withKeyId
```
public DecryptResult withKeyId(String keyId)
```
    The Amazon Resource Name (key ARN) of the KMS key that was used to decrypt the ciphertext.
    
    Parameters:
    
    keyId - The Amazon Resource Name (key ARN) of the KMS key that was used to decrypt the ciphertext.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPlaintext
```
public void setPlaintext(ByteBuffer plaintext)
```
    Decrypted plaintext data. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
    
    If the response includes the CiphertextForRecipient field, the Plaintext field is null or empty.
    
    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:
    
    plaintext - Decrypted plaintext data. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
    
    If the response includes the CiphertextForRecipient field, the Plaintext field is null or empty.
  - getPlaintext
```
public ByteBuffer getPlaintext()
```
    Decrypted plaintext data. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
    
    If the response includes the CiphertextForRecipient field, the Plaintext field is null or empty.
    
    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:
    
    Decrypted plaintext data. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
    
    If the response includes the CiphertextForRecipient field, the Plaintext field is null or empty.
  - withPlaintext
```
public DecryptResult withPlaintext(ByteBuffer plaintext)
```
    Decrypted plaintext data. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
    
    If the response includes the CiphertextForRecipient field, the Plaintext field is null or empty.
    
    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:
    
    plaintext - Decrypted plaintext data. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
    
    If the response includes the CiphertextForRecipient field, the Plaintext field is null or empty.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEncryptionAlgorithm
```
public void setEncryptionAlgorithm(String encryptionAlgorithm)
```
    The encryption algorithm that was used to decrypt the ciphertext.
    
    Parameters:
    
    encryptionAlgorithm - The encryption algorithm that was used to decrypt the ciphertext.
    
    See Also:
    
    EncryptionAlgorithmSpec
  - getEncryptionAlgorithm
```
public String getEncryptionAlgorithm()
```
    The encryption algorithm that was used to decrypt the ciphertext.
    
    Returns:
    
    The encryption algorithm that was used to decrypt the ciphertext.
    
    See Also:
    
    EncryptionAlgorithmSpec
  - withEncryptionAlgorithm
```
public DecryptResult withEncryptionAlgorithm(String encryptionAlgorithm)
```
    The encryption algorithm that was used to decrypt the ciphertext.
    
    Parameters:
    
    encryptionAlgorithm - The encryption algorithm that was used to decrypt the ciphertext.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EncryptionAlgorithmSpec
  - withEncryptionAlgorithm
```
public DecryptResult withEncryptionAlgorithm(EncryptionAlgorithmSpec encryptionAlgorithm)
```
    The encryption algorithm that was used to decrypt the ciphertext.
    
    Parameters:
    
    encryptionAlgorithm - The encryption algorithm that was used to decrypt the ciphertext.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EncryptionAlgorithmSpec
  - setCiphertextForRecipient
```
public void setCiphertextForRecipient(ByteBuffer ciphertextForRecipient)
```
    The plaintext data encrypted with the public key in the attestation document.
    
    This field is included in the response only when the Recipient parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.
    
    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:
    
    ciphertextForRecipient - The plaintext data encrypted with the public key in the attestation document.
    
    This field is included in the response only when the Recipient parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.
  - getCiphertextForRecipient
```
public ByteBuffer getCiphertextForRecipient()
```
    The plaintext data encrypted with the public key in the attestation document.
    
    This field is included in the response only when the Recipient parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.
    
    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:
    
    The plaintext data encrypted with the public key in the attestation document.
    
    This field is included in the response only when the Recipient parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.
  - withCiphertextForRecipient
```
public DecryptResult withCiphertextForRecipient(ByteBuffer ciphertextForRecipient)
```
    The plaintext data encrypted with the public key in the attestation document.
    
    This field is included in the response only when the Recipient parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.
    
    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:
    
    ciphertextForRecipient - The plaintext data encrypted with the public key in the attestation document.
    
    This field is included in the response only when the Recipient parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the 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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    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 DecryptResult clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.778

Class DecryptResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DecryptResult

Method Detail

setKeyId

getKeyId

withKeyId

setPlaintext

getPlaintext

withPlaintext

setEncryptionAlgorithm

getEncryptionAlgorithm

withEncryptionAlgorithm

withEncryptionAlgorithm

setCiphertextForRecipient

getCiphertextForRecipient

withCiphertextForRecipient

toString

equals

hashCode

clone