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

Class IcebergStructField

java.lang.Object

software.amazon.awssdk.services.glue.model.IcebergStructField

All Implemented Interfaces:

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

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

Defines a single field within an Iceberg table schema, including its identifier, name, data type, nullability, and documentation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IcebergStructField.Builder

Method Summary

Modifier and Type	Method	Description
static IcebergStructField.Builder	builder()
String	doc()	Optional documentation or description text that provides additional context about the purpose and usage of this field.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	id()	The unique identifier assigned to this field within the Iceberg table schema, used for schema evolution and field tracking.
String	name()	The name of the field as it appears in the table schema and query operations.
Boolean	required()	Indicates whether this field is required (non-nullable) or optional (nullable) in the table schema.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends IcebergStructField.Builder>	serializableBuilderClass()
IcebergStructField.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Document	type()	The data type definition for this field, specifying the structure and format of the data it contains.

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

id

public final Integer id()

The unique identifier assigned to this field within the Iceberg table schema, used for schema evolution and field tracking.

Returns:

The unique identifier assigned to this field within the Iceberg table schema, used for schema evolution and field tracking.

name

public final String name()

The name of the field as it appears in the table schema and query operations.

Returns:

The name of the field as it appears in the table schema and query operations.

type

public final Document type()

The data type definition for this field, specifying the structure and format of the data it contains.

Returns:

The data type definition for this field, specifying the structure and format of the data it contains.

required

public final Boolean required()

Indicates whether this field is required (non-nullable) or optional (nullable) in the table schema.

Returns:

Indicates whether this field is required (non-nullable) or optional (nullable) in the table schema.

doc

public final String doc()

Optional documentation or description text that provides additional context about the purpose and usage of this field.

Returns:

Optional documentation or description text that provides additional context about the purpose and usage of this field.

toBuilder

public IcebergStructField.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<IcebergStructField.Builder,IcebergStructField>

builder

public static IcebergStructField.Builder builder()

serializableBuilderClass

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