Package software.amazon.awssdk.services.xray.model

Class EncryptionConfig

java.lang.Object

software.amazon.awssdk.services.xray.model.EncryptionConfig

All Implemented Interfaces:

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

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

A configuration document that specifies encryption configuration settings.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EncryptionConfig.Builder

Method Summary

Modifier and Type	Method	Description
static EncryptionConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	keyId()	The ID of the KMS key used for encryption, if applicable.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends EncryptionConfig.Builder>	serializableBuilderClass()
EncryptionStatus	status()	The encryption status.
String	statusAsString()	The encryption status.
EncryptionConfig.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
EncryptionType	type()	The type of encryption.
String	typeAsString()	The type of encryption.

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 ID of the KMS key used for encryption, if applicable.

Returns:

The ID of the KMS key used for encryption, if applicable.

status

public final EncryptionStatus status()

The encryption status. While the status is UPDATING, X-Ray may encrypt data with a combination of the new and old settings.

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

Returns:

The encryption status. While the status is UPDATING, X-Ray may encrypt data with a combination of the new and old settings.

See Also:

EncryptionStatus

statusAsString

public final String statusAsString()

The encryption status. While the status is UPDATING, X-Ray may encrypt data with a combination of the new and old settings.

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

Returns:

The encryption status. While the status is UPDATING, X-Ray may encrypt data with a combination of the new and old settings.

See Also:

EncryptionStatus

type

public final EncryptionType type()

The type of encryption. Set to KMS for encryption with KMS keys. Set to NONE for default encryption.

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

Returns:

The type of encryption. Set to KMS for encryption with KMS keys. Set to NONE for default encryption.

See Also:

EncryptionType

typeAsString

public final String typeAsString()

The type of encryption. Set to KMS for encryption with KMS keys. Set to NONE for default encryption.

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

Returns:

The type of encryption. Set to KMS for encryption with KMS keys. Set to NONE for default encryption.

See Also:

EncryptionType

toBuilder

public EncryptionConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EncryptionConfig.Builder,EncryptionConfig>

builder

public static EncryptionConfig.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

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

Specified by:

sdkFieldNameToField in interface SdkPojo