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

Class PutEncryptionConfigRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.xray.model.XRayRequest

software.amazon.awssdk.services.xray.model.PutEncryptionConfigRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutEncryptionConfigRequest.Builder,PutEncryptionConfigRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutEncryptionConfigRequest.Builder

Method Summary

Modifier and Type	Method	Description
static PutEncryptionConfigRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	keyId()	An Amazon Web Services KMS key in one of the following formats:
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends PutEncryptionConfigRequest.Builder>	serializableBuilderClass()
PutEncryptionConfigRequest.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 software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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()

An Amazon Web Services KMS key in one of the following formats:

• Alias - The name of the key. For example, alias/MyKey.

• Key ID - The KMS key ID of the key. For example, ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Amazon Web Services X-Ray does not support asymmetric KMS keys.

• ARN - The full Amazon Resource Name of the key ID or alias. For example, arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Use this format to specify a key in a different account.

Omit this key if you set Type to NONE.

Returns:

An Amazon Web Services KMS key in one of the following formats:

• Alias - The name of the key. For example, alias/MyKey.

• Key ID - The KMS key ID of the key. For example, ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Amazon Web Services X-Ray does not support asymmetric KMS keys.

• ARN - The full Amazon Resource Name of the key ID or alias. For example, arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Use this format to specify a key in a different account.

Omit this key if you set Type to NONE.

type

public final EncryptionType type()

The type of encryption. Set to KMS to use your own key for encryption. 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 to use your own key for encryption. Set to NONE for default encryption.

See Also:

EncryptionType

typeAsString

public final String typeAsString()

The type of encryption. Set to KMS to use your own key for encryption. 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 to use your own key for encryption. Set to NONE for default encryption.

See Also:

EncryptionType

toBuilder

public PutEncryptionConfigRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutEncryptionConfigRequest.Builder,PutEncryptionConfigRequest>

Specified by:

toBuilder in class XRayRequest

builder

public static PutEncryptionConfigRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

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