Package software.amazon.awssdk.services.kms.model

Class DecryptResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.kms.model.KmsResponse

software.amazon.awssdk.services.kms.model.DecryptResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DecryptResponse.Builder,DecryptResponse>

@Generated("software.amazon.awssdk:codegen")
public final class DecryptResponse
extends KmsResponse
implements ToCopyableBuilder<DecryptResponse.Builder,DecryptResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DecryptResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DecryptResponse.Builder	builder()
SdkBytes	ciphertextForRecipient()	The plaintext data encrypted with the public key in the attestation document.
EncryptionAlgorithmSpec	encryptionAlgorithm()	The encryption algorithm that was used to decrypt the ciphertext.
String	encryptionAlgorithmAsString()	The encryption algorithm that was used to decrypt the ciphertext.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	keyId()	The Amazon Resource Name (key ARN) of the KMS key that was used to decrypt the ciphertext.
SdkBytes	plaintext()	Decrypted plaintext data.
List<SdkField<?>>	sdkFields()
static Class<? extends DecryptResponse.Builder>	serializableBuilderClass()
DecryptResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.kms.model.KmsResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

keyId

public final String keyId()

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.

plaintext

public final SdkBytes 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:

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.

encryptionAlgorithm

public final EncryptionAlgorithmSpec encryptionAlgorithm()

The encryption algorithm that was used to decrypt the ciphertext.

If the service returns an enum value that is not available in the current SDK version, encryptionAlgorithm will return EncryptionAlgorithmSpec.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from encryptionAlgorithmAsString().

Returns:

The encryption algorithm that was used to decrypt the ciphertext.

See Also:

EncryptionAlgorithmSpec

encryptionAlgorithmAsString

public final String encryptionAlgorithmAsString()

The encryption algorithm that was used to decrypt the ciphertext.

If the service returns an enum value that is not available in the current SDK version, encryptionAlgorithm will return EncryptionAlgorithmSpec.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from encryptionAlgorithmAsString().

Returns:

The encryption algorithm that was used to decrypt the ciphertext.

See Also:

EncryptionAlgorithmSpec

ciphertextForRecipient

public final SdkBytes 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:

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.

toBuilder

public DecryptResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DecryptResponse.Builder,DecryptResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DecryptResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DecryptResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo