Package software.amazon.awssdk.services.glue.model

Class IcebergEncryptedKey

java.lang.Object

software.amazon.awssdk.services.glue.model.IcebergEncryptedKey

All Implemented Interfaces:

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

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

Encryption key structure used for Iceberg table encryption. Contains the key ID, encrypted key metadata, optional reference to the encrypting key, and additional properties for the table's encryption scheme.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IcebergEncryptedKey.Builder

Method Summary

Modifier and Type	Method	Description
static IcebergEncryptedKey.Builder	builder()
String	encryptedById()	Optional ID of the key used to encrypt or wrap the key metadata in Iceberg table encryption.
String	encryptedKeyMetadata()	Encrypted key and metadata, base64 encoded.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasProperties()	For responses, this returns true if the service returned a value for the Properties property.
String	keyId()	Unique identifier of the encryption key used for Iceberg table encryption.
Map<String,String>	properties()	A string to string map of additional metadata used by the table's encryption scheme.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends IcebergEncryptedKey.Builder>	serializableBuilderClass()
IcebergEncryptedKey.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

keyId

public final String keyId()

Unique identifier of the encryption key used for Iceberg table encryption. This ID is used to reference the key in table metadata and track which key was used to encrypt specific data.

Returns:

Unique identifier of the encryption key used for Iceberg table encryption. This ID is used to reference the key in table metadata and track which key was used to encrypt specific data.

encryptedKeyMetadata

public final String encryptedKeyMetadata()

Encrypted key and metadata, base64 encoded. The format of encrypted key metadata is determined by the table's encryption scheme and can be a wrapped format specific to the table's KMS provider.

Returns:

Encrypted key and metadata, base64 encoded. The format of encrypted key metadata is determined by the table's encryption scheme and can be a wrapped format specific to the table's KMS provider.

encryptedById

public final String encryptedById()

Optional ID of the key used to encrypt or wrap the key metadata in Iceberg table encryption. This field references another encryption key that was used to encrypt the current key's metadata.

Returns:

Optional ID of the key used to encrypt or wrap the key metadata in Iceberg table encryption. This field references another encryption key that was used to encrypt the current key's metadata.

hasProperties

public final boolean hasProperties()

For responses, this returns true if the service returned a value for the Properties property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

properties

public final Map<String,String> properties()

A string to string map of additional metadata used by the table's encryption scheme. These properties provide additional context and configuration for the encryption key implementation.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasProperties() method.

Returns:

A string to string map of additional metadata used by the table's encryption scheme. These properties provide additional context and configuration for the encryption key implementation.

toBuilder

public IcebergEncryptedKey.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<IcebergEncryptedKey.Builder,IcebergEncryptedKey>

builder

public static IcebergEncryptedKey.Builder builder()

serializableBuilderClass

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