com.amazonaws.services.kms.model.DecryptResult Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kms Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.kms.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DecryptResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* The Amazon Resource Name (key ARN) of the KMS
* key that was used to decrypt the ciphertext.
*
*/
private String keyId;
/**
*
* 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.
*
*/
private java.nio.ByteBuffer plaintext;
/**
*
* The encryption algorithm that was used to decrypt the ciphertext.
*
*/
private String encryptionAlgorithm;
/**
*
* 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.
*
*/
private java.nio.ByteBuffer ciphertextForRecipient;
/**
*
* The Amazon Resource Name (key ARN) of the KMS
* key that was used to decrypt the ciphertext.
*
*
* @param keyId
* The Amazon Resource Name (key ARN) of
* the KMS key that was used to decrypt the ciphertext.
*/
public void setKeyId(String keyId) {
this.keyId = keyId;
}
/**
*
* The Amazon Resource Name (key ARN) of the KMS
* key that was used to decrypt the ciphertext.
*
*
* @return The Amazon Resource Name (key ARN) of
* the KMS key that was used to decrypt the ciphertext.
*/
public String getKeyId() {
return this.keyId;
}
/**
*
* The Amazon Resource Name (key ARN) of the KMS
* key that was used to decrypt the ciphertext.
*
*
* @param keyId
* The Amazon Resource Name (key ARN) of
* the KMS key that was used to decrypt the ciphertext.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DecryptResult withKeyId(String keyId) {
setKeyId(keyId);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setPlaintext(java.nio.ByteBuffer plaintext) {
this.plaintext = 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.
*
*
* {@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend
* using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent
* {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}.
* Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the
* {@code position}.
*
*
* @return 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.
*/
public java.nio.ByteBuffer getPlaintext() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DecryptResult withPlaintext(java.nio.ByteBuffer plaintext) {
setPlaintext(plaintext);
return this;
}
/**
*
* The encryption algorithm that was used to decrypt the ciphertext.
*
*
* @param encryptionAlgorithm
* The encryption algorithm that was used to decrypt the ciphertext.
* @see EncryptionAlgorithmSpec
*/
public void setEncryptionAlgorithm(String encryptionAlgorithm) {
this.encryptionAlgorithm = encryptionAlgorithm;
}
/**
*
* The encryption algorithm that was used to decrypt the ciphertext.
*
*
* @return The encryption algorithm that was used to decrypt the ciphertext.
* @see EncryptionAlgorithmSpec
*/
public String getEncryptionAlgorithm() {
return this.encryptionAlgorithm;
}
/**
*
* The encryption algorithm that was used to decrypt the ciphertext.
*
*
* @param encryptionAlgorithm
* The encryption algorithm that was used to decrypt the ciphertext.
* @return Returns a reference to this object so that method calls can be chained together.
* @see EncryptionAlgorithmSpec
*/
public DecryptResult withEncryptionAlgorithm(String encryptionAlgorithm) {
setEncryptionAlgorithm(encryptionAlgorithm);
return this;
}
/**
*
* The encryption algorithm that was used to decrypt the ciphertext.
*
*
* @param encryptionAlgorithm
* The encryption algorithm that was used to decrypt the ciphertext.
* @return Returns a reference to this object so that method calls can be chained together.
* @see EncryptionAlgorithmSpec
*/
public DecryptResult withEncryptionAlgorithm(EncryptionAlgorithmSpec encryptionAlgorithm) {
this.encryptionAlgorithm = encryptionAlgorithm.toString();
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setCiphertextForRecipient(java.nio.ByteBuffer ciphertextForRecipient) {
this.ciphertextForRecipient = 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.
*
*
* {@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend
* using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent
* {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}.
* Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the
* {@code position}.
*
*
* @return 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.
*/
public java.nio.ByteBuffer getCiphertextForRecipient() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DecryptResult withCiphertextForRecipient(java.nio.ByteBuffer ciphertextForRecipient) {
setCiphertextForRecipient(ciphertextForRecipient);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getKeyId() != null)
sb.append("KeyId: ").append(getKeyId()).append(",");
if (getPlaintext() != null)
sb.append("Plaintext: ").append("***Sensitive Data Redacted***").append(",");
if (getEncryptionAlgorithm() != null)
sb.append("EncryptionAlgorithm: ").append(getEncryptionAlgorithm()).append(",");
if (getCiphertextForRecipient() != null)
sb.append("CiphertextForRecipient: ").append(getCiphertextForRecipient());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DecryptResult == false)
return false;
DecryptResult other = (DecryptResult) obj;
if (other.getKeyId() == null ^ this.getKeyId() == null)
return false;
if (other.getKeyId() != null && other.getKeyId().equals(this.getKeyId()) == false)
return false;
if (other.getPlaintext() == null ^ this.getPlaintext() == null)
return false;
if (other.getPlaintext() != null && other.getPlaintext().equals(this.getPlaintext()) == false)
return false;
if (other.getEncryptionAlgorithm() == null ^ this.getEncryptionAlgorithm() == null)
return false;
if (other.getEncryptionAlgorithm() != null && other.getEncryptionAlgorithm().equals(this.getEncryptionAlgorithm()) == false)
return false;
if (other.getCiphertextForRecipient() == null ^ this.getCiphertextForRecipient() == null)
return false;
if (other.getCiphertextForRecipient() != null && other.getCiphertextForRecipient().equals(this.getCiphertextForRecipient()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getKeyId() == null) ? 0 : getKeyId().hashCode());
hashCode = prime * hashCode + ((getPlaintext() == null) ? 0 : getPlaintext().hashCode());
hashCode = prime * hashCode + ((getEncryptionAlgorithm() == null) ? 0 : getEncryptionAlgorithm().hashCode());
hashCode = prime * hashCode + ((getCiphertextForRecipient() == null) ? 0 : getCiphertextForRecipient().hashCode());
return hashCode;
}
@Override
public DecryptResult clone() {
try {
return (DecryptResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}