software.amazon.awssdk.services.paymentcryptographydata.model

Class SymmetricEncryptionAttributes

java.lang.Object

software.amazon.awssdk.services.paymentcryptographydata.model.SymmetricEncryptionAttributes

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SymmetricEncryptionAttributes.Builder,SymmetricEncryptionAttributes>

@Generated(value="software.amazon.awssdk:codegen")
public final class SymmetricEncryptionAttributes
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SymmetricEncryptionAttributes.Builder,SymmetricEncryptionAttributes>

Parameters requried to encrypt plaintext data using symmetric keys.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SymmetricEncryptionAttributes.Builder

Method Summary

Modifier and Type	Method and Description
static SymmetricEncryptionAttributes.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	initializationVector() An input to cryptographic primitive used to provide the intial state.
EncryptionMode	mode() The block cipher mode of operation.
String	modeAsString() The block cipher mode of operation.
PaddingType	paddingType() The padding to be included with the data.
String	paddingTypeAsString() The padding to be included with the data.
List<SdkField<?>>	sdkFields()
static Class<? extends SymmetricEncryptionAttributes.Builder>	serializableBuilderClass()
SymmetricEncryptionAttributes.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

initializationVector

public final String initializationVector()

An input to cryptographic primitive used to provide the intial state. The InitializationVector is typically required have a random or psuedo-random value, but sometimes it only needs to be unpredictable or unique. If a value is not provided, Amazon Web Services Payment Cryptography generates a random value.

Returns:

An input to cryptographic primitive used to provide the intial state. The InitializationVector is typically required have a random or psuedo-random value, but sometimes it only needs to be unpredictable or unique. If a value is not provided, Amazon Web Services Payment Cryptography generates a random value.

mode

public final EncryptionMode mode()

The block cipher mode of operation. Block ciphers are designed to encrypt a block of data of fixed size (for example, 128 bits). The size of the input block is usually same as the size of the encrypted output block, while the key length can be different. A mode of operation describes how to repeatedly apply a cipher's single-block operation to securely transform amounts of data larger than a block.

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

Returns:

The block cipher mode of operation. Block ciphers are designed to encrypt a block of data of fixed size (for example, 128 bits). The size of the input block is usually same as the size of the encrypted output block, while the key length can be different. A mode of operation describes how to repeatedly apply a cipher's single-block operation to securely transform amounts of data larger than a block.

See Also:

EncryptionMode

modeAsString

public final String modeAsString()

The block cipher mode of operation. Block ciphers are designed to encrypt a block of data of fixed size (for example, 128 bits). The size of the input block is usually same as the size of the encrypted output block, while the key length can be different. A mode of operation describes how to repeatedly apply a cipher's single-block operation to securely transform amounts of data larger than a block.

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

Returns:

The block cipher mode of operation. Block ciphers are designed to encrypt a block of data of fixed size (for example, 128 bits). The size of the input block is usually same as the size of the encrypted output block, while the key length can be different. A mode of operation describes how to repeatedly apply a cipher's single-block operation to securely transform amounts of data larger than a block.

See Also:

EncryptionMode

paddingType

public final PaddingType paddingType()

The padding to be included with the data.

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

Returns:

The padding to be included with the data.

See Also:

PaddingType

paddingTypeAsString

public final String paddingTypeAsString()

The padding to be included with the data.

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

Returns:

The padding to be included with the data.

See Also:

PaddingType

toBuilder

public SymmetricEncryptionAttributes.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SymmetricEncryptionAttributes.Builder,SymmetricEncryptionAttributes>

builder

public static SymmetricEncryptionAttributes.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo