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(value="software.amazon.awssdk:codegen")
public final class PutEncryptionConfigRequest
extends XRayRequest
implements ToCopyableBuilder<PutEncryptionConfigRequest.Builder,PutEncryptionConfigRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PutEncryptionConfigRequest.Builder

Method Summary

Modifier and Type	Method and Description
static PutEncryptionConfigRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	keyId() An AWS KMS customer master key (CMK) in one of the following formats:
List<SdkField<?>>	sdkFields()
static Class<? extends PutEncryptionConfigRequest.Builder>	serializableBuilderClass()
PutEncryptionConfigRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
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

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

keyId

public String keyId()

An AWS KMS customer master key (CMK) 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.

• 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 AWS KMS customer master key (CMK) 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.

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

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<PutEncryptionConfigRequest.Builder,PutEncryptionConfigRequest>

Specified by:

toBuilder in class XRayRequest

Returns:

a builder for type T

builder

public static PutEncryptionConfigRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.