Interface EncryptDataRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<EncryptDataRequest.Builder,EncryptDataRequest>, PaymentCryptographyDataRequest.Builder, SdkBuilder<EncryptDataRequest.Builder,EncryptDataRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

EncryptDataRequest

@Mutable
@NotThreadSafe
public static interface EncryptDataRequest.Builder
extends PaymentCryptographyDataRequest.Builder, SdkPojo, CopyableBuilder<EncryptDataRequest.Builder,EncryptDataRequest>

Method Summary

Modifier and Type	Method	Description
default EncryptDataRequest.Builder	encryptionAttributes(Consumer<EncryptionDecryptionAttributes.Builder> encryptionAttributes)	The encryption key type and attributes for plaintext encryption.
EncryptDataRequest.Builder	encryptionAttributes(EncryptionDecryptionAttributes encryptionAttributes)	The encryption key type and attributes for plaintext encryption.
EncryptDataRequest.Builder	keyIdentifier(String keyIdentifier)	The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for plaintext encryption.
EncryptDataRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
EncryptDataRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
EncryptDataRequest.Builder	plainText(String plainText)	The plaintext to be encrypted.
default EncryptDataRequest.Builder	wrappedKey(Consumer<WrappedKey.Builder> wrappedKey)	The WrappedKeyBlock containing the encryption key for plaintext encryption.
EncryptDataRequest.Builder	wrappedKey(WrappedKey wrappedKey)	The WrappedKeyBlock containing the encryption key for plaintext encryption.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.paymentcryptographydata.model.PaymentCryptographyDataRequest.Builder

build

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

keyIdentifier

EncryptDataRequest.Builder keyIdentifier(String keyIdentifier)

The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for plaintext encryption.

When a WrappedKeyBlock is provided, this value will be the identifier to the key wrapping key. Otherwise, it is the key identifier used to perform the operation.

Parameters:

keyIdentifier - The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for plaintext encryption.

When a WrappedKeyBlock is provided, this value will be the identifier to the key wrapping key. Otherwise, it is the key identifier used to perform the operation.

Returns:

Returns a reference to this object so that method calls can be chained together.

plainText

EncryptDataRequest.Builder plainText(String plainText)

The plaintext to be encrypted.

For encryption using asymmetric keys, plaintext data length is constrained by encryption key strength that you define in KeyAlgorithm and padding type that you define in AsymmetricEncryptionAttributes. For more information, see Encrypt data in the Amazon Web Services Payment Cryptography User Guide.

Parameters:

plainText - The plaintext to be encrypted.

For encryption using asymmetric keys, plaintext data length is constrained by encryption key strength that you define in KeyAlgorithm and padding type that you define in AsymmetricEncryptionAttributes. For more information, see Encrypt data in the Amazon Web Services Payment Cryptography User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

encryptionAttributes

EncryptDataRequest.Builder encryptionAttributes(EncryptionDecryptionAttributes encryptionAttributes)

The encryption key type and attributes for plaintext encryption.

Parameters:

encryptionAttributes - The encryption key type and attributes for plaintext encryption.

Returns:

Returns a reference to this object so that method calls can be chained together.

encryptionAttributes

default EncryptDataRequest.Builder encryptionAttributes(Consumer<EncryptionDecryptionAttributes.Builder> encryptionAttributes)

The encryption key type and attributes for plaintext encryption.

This is a convenience method that creates an instance of the EncryptionDecryptionAttributes.Builder avoiding the need to create one manually via EncryptionDecryptionAttributes.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to encryptionAttributes(EncryptionDecryptionAttributes).

Parameters:

encryptionAttributes - a consumer that will call methods on EncryptionDecryptionAttributes.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• encryptionAttributes(EncryptionDecryptionAttributes)

wrappedKey

EncryptDataRequest.Builder wrappedKey(WrappedKey wrappedKey)

The WrappedKeyBlock containing the encryption key for plaintext encryption.

Parameters:

wrappedKey - The WrappedKeyBlock containing the encryption key for plaintext encryption.

Returns:

Returns a reference to this object so that method calls can be chained together.

wrappedKey

default EncryptDataRequest.Builder wrappedKey(Consumer<WrappedKey.Builder> wrappedKey)

The WrappedKeyBlock containing the encryption key for plaintext encryption.

This is a convenience method that creates an instance of the WrappedKey.Builder avoiding the need to create one manually via WrappedKey.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to wrappedKey(WrappedKey).

Parameters:

wrappedKey - a consumer that will call methods on WrappedKey.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• wrappedKey(WrappedKey)

overrideConfiguration

EncryptDataRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

EncryptDataRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.