Interface TableOptimizerRun.Builder

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

  • Method Details

    • eventType

      TableOptimizerRun.Builder eventType(String eventType)

      An event type representing the status of the table optimizer run.

      Parameters:
      eventType - An event type representing the status of the table optimizer run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • eventType

      TableOptimizerRun.Builder eventType(TableOptimizerEventType eventType)

      An event type representing the status of the table optimizer run.

      Parameters:
      eventType - An event type representing the status of the table optimizer run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • startTimestamp

      TableOptimizerRun.Builder startTimestamp(Instant startTimestamp)

      Represents the epoch timestamp at which the compaction job was started within Lake Formation.

      Parameters:
      startTimestamp - Represents the epoch timestamp at which the compaction job was started within Lake Formation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endTimestamp

      TableOptimizerRun.Builder endTimestamp(Instant endTimestamp)

      Represents the epoch timestamp at which the compaction job ended.

      Parameters:
      endTimestamp - Represents the epoch timestamp at which the compaction job ended.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metrics

      @Deprecated TableOptimizerRun.Builder metrics(RunMetrics metrics)
      Deprecated.
      Metrics has been replaced by optimizer type specific metrics such as IcebergCompactionMetrics

      A RunMetrics object containing metrics for the optimizer run.

      This member is deprecated. See the individual metric members for compaction, retention, and orphan file deletion.

      Parameters:
      metrics - A RunMetrics object containing metrics for the optimizer run.

      This member is deprecated. See the individual metric members for compaction, retention, and orphan file deletion.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metrics

      @Deprecated default TableOptimizerRun.Builder metrics(Consumer<RunMetrics.Builder> metrics)
      Deprecated.
      Metrics has been replaced by optimizer type specific metrics such as IcebergCompactionMetrics

      A RunMetrics object containing metrics for the optimizer run.

      This member is deprecated. See the individual metric members for compaction, retention, and orphan file deletion.

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

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

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

    • error

      TableOptimizerRun.Builder error(String error)

      An error that occured during the optimizer run.

      Parameters:
      error - An error that occured during the optimizer run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • compactionMetrics

      TableOptimizerRun.Builder compactionMetrics(CompactionMetrics compactionMetrics)

      A CompactionMetrics object containing metrics for the optimizer run.

      Parameters:
      compactionMetrics - A CompactionMetrics object containing metrics for the optimizer run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • compactionMetrics

      default TableOptimizerRun.Builder compactionMetrics(Consumer<CompactionMetrics.Builder> compactionMetrics)

      A CompactionMetrics object containing metrics for the optimizer run.

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

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

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

    • compactionStrategy

      TableOptimizerRun.Builder compactionStrategy(String compactionStrategy)

      The strategy used for the compaction run. Indicates which algorithm was applied to determine how files were selected and combined during the compaction process. Valid values are:

      • binpack: Combines small files into larger files, typically targeting sizes over 100MB, while applying any pending deletes. This is the recommended compaction strategy for most use cases.

      • sort: Organizes data based on specified columns which are sorted hierarchically during compaction, improving query performance for filtered operations. This strategy is recommended when your queries frequently filter on specific columns. To use this strategy, you must first define a sort order in your Iceberg table properties using the sort_order table property.

      • z-order: Optimizes data organization by blending multiple attributes into a single scalar value that can be used for sorting, allowing efficient querying across multiple dimensions. This strategy is recommended when you need to query data across multiple dimensions simultaneously. To use this strategy, you must first define a sort order in your Iceberg table properties using the sort_order table property.

      Parameters:
      compactionStrategy - The strategy used for the compaction run. Indicates which algorithm was applied to determine how files were selected and combined during the compaction process. Valid values are:

      • binpack: Combines small files into larger files, typically targeting sizes over 100MB, while applying any pending deletes. This is the recommended compaction strategy for most use cases.

      • sort: Organizes data based on specified columns which are sorted hierarchically during compaction, improving query performance for filtered operations. This strategy is recommended when your queries frequently filter on specific columns. To use this strategy, you must first define a sort order in your Iceberg table properties using the sort_order table property.

      • z-order: Optimizes data organization by blending multiple attributes into a single scalar value that can be used for sorting, allowing efficient querying across multiple dimensions. This strategy is recommended when you need to query data across multiple dimensions simultaneously. To use this strategy, you must first define a sort order in your Iceberg table properties using the sort_order table property.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • compactionStrategy

      TableOptimizerRun.Builder compactionStrategy(CompactionStrategy compactionStrategy)

      The strategy used for the compaction run. Indicates which algorithm was applied to determine how files were selected and combined during the compaction process. Valid values are:

      • binpack: Combines small files into larger files, typically targeting sizes over 100MB, while applying any pending deletes. This is the recommended compaction strategy for most use cases.

      • sort: Organizes data based on specified columns which are sorted hierarchically during compaction, improving query performance for filtered operations. This strategy is recommended when your queries frequently filter on specific columns. To use this strategy, you must first define a sort order in your Iceberg table properties using the sort_order table property.

      • z-order: Optimizes data organization by blending multiple attributes into a single scalar value that can be used for sorting, allowing efficient querying across multiple dimensions. This strategy is recommended when you need to query data across multiple dimensions simultaneously. To use this strategy, you must first define a sort order in your Iceberg table properties using the sort_order table property.

      Parameters:
      compactionStrategy - The strategy used for the compaction run. Indicates which algorithm was applied to determine how files were selected and combined during the compaction process. Valid values are:

      • binpack: Combines small files into larger files, typically targeting sizes over 100MB, while applying any pending deletes. This is the recommended compaction strategy for most use cases.

      • sort: Organizes data based on specified columns which are sorted hierarchically during compaction, improving query performance for filtered operations. This strategy is recommended when your queries frequently filter on specific columns. To use this strategy, you must first define a sort order in your Iceberg table properties using the sort_order table property.

      • z-order: Optimizes data organization by blending multiple attributes into a single scalar value that can be used for sorting, allowing efficient querying across multiple dimensions. This strategy is recommended when you need to query data across multiple dimensions simultaneously. To use this strategy, you must first define a sort order in your Iceberg table properties using the sort_order table property.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • retentionMetrics

      TableOptimizerRun.Builder retentionMetrics(RetentionMetrics retentionMetrics)

      A RetentionMetrics object containing metrics for the optimizer run.

      Parameters:
      retentionMetrics - A RetentionMetrics object containing metrics for the optimizer run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • retentionMetrics

      default TableOptimizerRun.Builder retentionMetrics(Consumer<RetentionMetrics.Builder> retentionMetrics)

      A RetentionMetrics object containing metrics for the optimizer run.

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

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

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

    • orphanFileDeletionMetrics

      TableOptimizerRun.Builder orphanFileDeletionMetrics(OrphanFileDeletionMetrics orphanFileDeletionMetrics)

      An OrphanFileDeletionMetrics object containing metrics for the optimizer run.

      Parameters:
      orphanFileDeletionMetrics - An OrphanFileDeletionMetrics object containing metrics for the optimizer run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • orphanFileDeletionMetrics

      default TableOptimizerRun.Builder orphanFileDeletionMetrics(Consumer<OrphanFileDeletionMetrics.Builder> orphanFileDeletionMetrics)

      An OrphanFileDeletionMetrics object containing metrics for the optimizer run.

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

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

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