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 Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description default TableOptimizerRun.BuildercompactionMetrics(Consumer<CompactionMetrics.Builder> compactionMetrics)ACompactionMetricsobject containing metrics for the optimizer run.TableOptimizerRun.BuildercompactionMetrics(CompactionMetrics compactionMetrics)ACompactionMetricsobject containing metrics for the optimizer run.TableOptimizerRun.BuildercompactionStrategy(String compactionStrategy)The strategy used for the compaction run.TableOptimizerRun.BuildercompactionStrategy(CompactionStrategy compactionStrategy)The strategy used for the compaction run.TableOptimizerRun.BuilderendTimestamp(Instant endTimestamp)Represents the epoch timestamp at which the compaction job ended.TableOptimizerRun.Buildererror(String error)An error that occured during the optimizer run.TableOptimizerRun.BuildereventType(String eventType)An event type representing the status of the table optimizer run.TableOptimizerRun.BuildereventType(TableOptimizerEventType eventType)An event type representing the status of the table optimizer run.default TableOptimizerRun.Buildermetrics(Consumer<RunMetrics.Builder> metrics)Deprecated.Metrics has been replaced by optimizer type specific metrics such as IcebergCompactionMetricsTableOptimizerRun.Buildermetrics(RunMetrics metrics)Deprecated.Metrics has been replaced by optimizer type specific metrics such as IcebergCompactionMetricsdefault TableOptimizerRun.BuilderorphanFileDeletionMetrics(Consumer<OrphanFileDeletionMetrics.Builder> orphanFileDeletionMetrics)AnOrphanFileDeletionMetricsobject containing metrics for the optimizer run.TableOptimizerRun.BuilderorphanFileDeletionMetrics(OrphanFileDeletionMetrics orphanFileDeletionMetrics)AnOrphanFileDeletionMetricsobject containing metrics for the optimizer run.default TableOptimizerRun.BuilderretentionMetrics(Consumer<RetentionMetrics.Builder> retentionMetrics)ARetentionMetricsobject containing metrics for the optimizer run.TableOptimizerRun.BuilderretentionMetrics(RetentionMetrics retentionMetrics)ARetentionMetricsobject containing metrics for the optimizer run.TableOptimizerRun.BuilderstartTimestamp(Instant startTimestamp)Represents the epoch timestamp at which the compaction job was started within Lake Formation.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
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:
TableOptimizerEventType,TableOptimizerEventType
-
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:
TableOptimizerEventType,TableOptimizerEventType
-
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 IcebergCompactionMetricsA
RunMetricsobject containing metrics for the optimizer run.This member is deprecated. See the individual metric members for compaction, retention, and orphan file deletion.
- Parameters:
metrics- ARunMetricsobject 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 IcebergCompactionMetricsA
RunMetricsobject 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 theRunMetrics.Builderavoiding the need to create one manually viaRunMetrics.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tometrics(RunMetrics).- Parameters:
metrics- a consumer that will call methods onRunMetrics.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
metrics(RunMetrics)
-
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
CompactionMetricsobject containing metrics for the optimizer run.- Parameters:
compactionMetrics- ACompactionMetricsobject 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
This is a convenience method that creates an instance of theCompactionMetricsobject containing metrics for the optimizer run.CompactionMetrics.Builderavoiding the need to create one manually viaCompactionMetrics.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tocompactionMetrics(CompactionMetrics).- Parameters:
compactionMetrics- a consumer that will call methods onCompactionMetrics.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
compactionMetrics(CompactionMetrics)
-
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 thesort_ordertable 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 thesort_ordertable 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 thesort_ordertable 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 thesort_ordertable property.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
CompactionStrategy,CompactionStrategy
-
-
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 thesort_ordertable 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 thesort_ordertable 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 thesort_ordertable 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 thesort_ordertable property.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
CompactionStrategy,CompactionStrategy
-
-
retentionMetrics
TableOptimizerRun.Builder retentionMetrics(RetentionMetrics retentionMetrics)
A
RetentionMetricsobject containing metrics for the optimizer run.- Parameters:
retentionMetrics- ARetentionMetricsobject 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
This is a convenience method that creates an instance of theRetentionMetricsobject containing metrics for the optimizer run.RetentionMetrics.Builderavoiding the need to create one manually viaRetentionMetrics.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toretentionMetrics(RetentionMetrics).- Parameters:
retentionMetrics- a consumer that will call methods onRetentionMetrics.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
retentionMetrics(RetentionMetrics)
-
orphanFileDeletionMetrics
TableOptimizerRun.Builder orphanFileDeletionMetrics(OrphanFileDeletionMetrics orphanFileDeletionMetrics)
An
OrphanFileDeletionMetricsobject containing metrics for the optimizer run.- Parameters:
orphanFileDeletionMetrics- AnOrphanFileDeletionMetricsobject 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
This is a convenience method that creates an instance of theOrphanFileDeletionMetricsobject containing metrics for the optimizer run.OrphanFileDeletionMetrics.Builderavoiding the need to create one manually viaOrphanFileDeletionMetrics.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toorphanFileDeletionMetrics(OrphanFileDeletionMetrics).- Parameters:
orphanFileDeletionMetrics- a consumer that will call methods onOrphanFileDeletionMetrics.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
orphanFileDeletionMetrics(OrphanFileDeletionMetrics)
-
-