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:

  • Method Details

    • 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.

    • initialDefault

      public final Document initialDefault()

      Default value used to populate the field's value for all records that were written before the field was added to the schema. This enables backward compatibility when adding new fields to existing Iceberg tables.

      Returns:
      Default value used to populate the field's value for all records that were written before the field was added to the schema. This enables backward compatibility when adding new fields to existing Iceberg tables.

    • writeDefault

      public final Document writeDefault()

      Default value used to populate the field's value for any records written after the field was added to the schema, if the writer does not supply the field's value. This can be changed through schema evolution.

      Returns:
      Default value used to populate the field's value for any records written after the field was added to the schema, if the writer does not supply the field's value. This can be changed through schema evolution.

    • toBuilder

      public IcebergStructField.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<IcebergStructField.Builder,IcebergStructField>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.