Interface IcebergMetadata.Builder

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

  • Method Details

    • schema

      IcebergMetadata.Builder schema(IcebergSchema schema)

      The schema for an Iceberg table. Use this property to define table schemas with primitive types only. For schemas that include nested or complex types such as struct, list, or map, use schemaV2 instead.

      Parameters:
      schema - The schema for an Iceberg table. Use this property to define table schemas with primitive types only. For schemas that include nested or complex types such as struct, list, or map, use schemaV2 instead.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • schema

      default IcebergMetadata.Builder schema(Consumer<IcebergSchema.Builder> schema)

      The schema for an Iceberg table. Use this property to define table schemas with primitive types only. For schemas that include nested or complex types such as struct, list, or map, use schemaV2 instead.

      This is a convenience method that creates an instance of the IcebergSchema.Builder avoiding the need to create one manually via IcebergSchema.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to schema(IcebergSchema).

      Parameters:
      schema - a consumer that will call methods on IcebergSchema.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • schemaV2

      IcebergMetadata.Builder schemaV2(IcebergSchemaV2 schemaV2)

      The schema for an Iceberg table using the V2 format. Use this property to define table schemas that include nested or complex data types such as struct, list, or map, in addition to primitive types. For schemas with only primitive types, you can use either schema or schemaV2.

      Parameters:
      schemaV2 - The schema for an Iceberg table using the V2 format. Use this property to define table schemas that include nested or complex data types such as struct, list, or map, in addition to primitive types. For schemas with only primitive types, you can use either schema or schemaV2.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • schemaV2

      default IcebergMetadata.Builder schemaV2(Consumer<IcebergSchemaV2.Builder> schemaV2)

      The schema for an Iceberg table using the V2 format. Use this property to define table schemas that include nested or complex data types such as struct, list, or map, in addition to primitive types. For schemas with only primitive types, you can use either schema or schemaV2.

      This is a convenience method that creates an instance of the IcebergSchemaV2.Builder avoiding the need to create one manually via IcebergSchemaV2.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to schemaV2(IcebergSchemaV2).

      Parameters:
      schemaV2 - a consumer that will call methods on IcebergSchemaV2.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • partitionSpec

      IcebergMetadata.Builder partitionSpec(IcebergPartitionSpec partitionSpec)

      The partition specification for the Iceberg table. Partitioning organizes data into separate files based on the values of one or more fields, which can improve query performance by reducing the amount of data scanned. Each partition field applies a transform (such as identity, year, month, or bucket) to a single field.

      Parameters:
      partitionSpec - The partition specification for the Iceberg table. Partitioning organizes data into separate files based on the values of one or more fields, which can improve query performance by reducing the amount of data scanned. Each partition field applies a transform (such as identity, year, month, or bucket) to a single field.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • partitionSpec

      default IcebergMetadata.Builder partitionSpec(Consumer<IcebergPartitionSpec.Builder> partitionSpec)

      The partition specification for the Iceberg table. Partitioning organizes data into separate files based on the values of one or more fields, which can improve query performance by reducing the amount of data scanned. Each partition field applies a transform (such as identity, year, month, or bucket) to a single field.

      This is a convenience method that creates an instance of the IcebergPartitionSpec.Builder avoiding the need to create one manually via IcebergPartitionSpec.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to partitionSpec(IcebergPartitionSpec).

      Parameters:
      partitionSpec - a consumer that will call methods on IcebergPartitionSpec.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • writeOrder

      IcebergMetadata.Builder writeOrder(IcebergSortOrder writeOrder)

      The sort order for the Iceberg table. Sort order defines how data is sorted within data files, which can improve query performance by enabling more efficient data skipping and filtering.

      Parameters:
      writeOrder - The sort order for the Iceberg table. Sort order defines how data is sorted within data files, which can improve query performance by enabling more efficient data skipping and filtering.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • writeOrder

      default IcebergMetadata.Builder writeOrder(Consumer<IcebergSortOrder.Builder> writeOrder)

      The sort order for the Iceberg table. Sort order defines how data is sorted within data files, which can improve query performance by enabling more efficient data skipping and filtering.

      This is a convenience method that creates an instance of the IcebergSortOrder.Builder avoiding the need to create one manually via IcebergSortOrder.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to writeOrder(IcebergSortOrder).

      Parameters:
      writeOrder - a consumer that will call methods on IcebergSortOrder.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • properties

      IcebergMetadata.Builder properties(Map<String,String> properties)

      A map of custom configuration properties for the Iceberg table.

      Parameters:
      properties - A map of custom configuration properties for the Iceberg table.
      Returns:
      Returns a reference to this object so that method calls can be chained together.