Interface IcebergStructField.Builder

All Superinterfaces:
Buildable, CopyableBuilder<IcebergStructField.Builder,IcebergStructField>, SdkBuilder<IcebergStructField.Builder,IcebergStructField>, SdkPojo
Enclosing class:
IcebergStructField
@Mutable @NotThreadSafe public static interface IcebergStructField.Builder extends SdkPojo, CopyableBuilder<IcebergStructField.Builder,IcebergStructField>

  • Method Details

    • id

      IcebergStructField.Builder id(Integer id)

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

      Parameters:
      id - The unique identifier assigned to this field within the Iceberg table schema, used for schema evolution and field tracking.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      IcebergStructField.Builder name(String name)

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

      Parameters:
      name - The name of the field as it appears in the table schema and query operations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • type

      IcebergStructField.Builder type(Document type)

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

      Parameters:
      type - The data type definition for this field, specifying the structure and format of the data it contains.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • required

      IcebergStructField.Builder required(Boolean required)

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

      Parameters:
      required - Indicates whether this field is required (non-nullable) or optional (nullable) in the table schema.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • doc

      IcebergStructField.Builder doc(String doc)

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

      Parameters:
      doc - Optional documentation or description text that provides additional context about the purpose and usage of this field.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • initialDefault

      IcebergStructField.Builder initialDefault(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • writeDefault

      IcebergStructField.Builder writeDefault(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.