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

Class EncryptResponse

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.EncryptResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<EncryptResponse.Builder,EncryptResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EncryptResponse.Builder

Method Summary

Modifier and Type	Method	Description
static EncryptResponse.Builder	builder()
final SdkBytes	ciphertextBlob()	The encrypted plaintext.
final EncryptionAlgorithmSpec	encryptionAlgorithm()	The encryption algorithm that was used to encrypt the plaintext.
final String	encryptionAlgorithmAsString()	The encryption algorithm that was used to encrypt the plaintext.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final String	keyId()	The Amazon Resource Name (key ARN) of the KMS key that was used to encrypt the plaintext.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends EncryptResponse.Builder>	serializableBuilderClass()
EncryptResponse.Builder	toBuilder()
final 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 Details

ciphertextBlob

public final SdkBytes ciphertextBlob()

The encrypted plaintext. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

Returns:

The encrypted plaintext. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

keyId

public final String keyId()

The Amazon Resource Name (key ARN) of the KMS key that was used to encrypt the plaintext.

Returns:

The Amazon Resource Name (key ARN) of the KMS key that was used to encrypt the plaintext.

encryptionAlgorithm

public final EncryptionAlgorithmSpec encryptionAlgorithm()

The encryption algorithm that was used to encrypt the plaintext.

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 encrypt the plaintext.

See Also:

• EncryptionAlgorithmSpec

encryptionAlgorithmAsString

public final String encryptionAlgorithmAsString()

The encryption algorithm that was used to encrypt the plaintext.

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 encrypt the plaintext.

See Also:

• EncryptionAlgorithmSpec

toBuilder

public EncryptResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EncryptResponse.Builder,EncryptResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static EncryptResponse.Builder builder()

serializableBuilderClass

public static Class<? extends EncryptResponse.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo