Interface IcebergRetentionConfiguration.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<IcebergRetentionConfiguration.Builder,
,IcebergRetentionConfiguration> SdkBuilder<IcebergRetentionConfiguration.Builder,
,IcebergRetentionConfiguration> SdkPojo
- Enclosing class:
IcebergRetentionConfiguration
-
Method Summary
Modifier and TypeMethodDescriptioncleanExpiredFiles
(Boolean cleanExpiredFiles) If set to false, snapshots are only deleted from table metadata, and the underlying data and metadata files are not deleted.numberOfSnapshotsToRetain
(Integer numberOfSnapshotsToRetain) The number of Iceberg snapshots to retain within the retention period.runRateInHours
(Integer runRateInHours) The interval in hours between retention job runs.snapshotRetentionPeriodInDays
(Integer snapshotRetentionPeriodInDays) The number of days to retain the Iceberg snapshots.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 Details
-
snapshotRetentionPeriodInDays
IcebergRetentionConfiguration.Builder snapshotRetentionPeriodInDays(Integer snapshotRetentionPeriodInDays) The number of days to retain the Iceberg snapshots. If an input is not provided, the corresponding Iceberg table configuration field will be used or if not present, the default value 5 will be used.
- Parameters:
snapshotRetentionPeriodInDays
- The number of days to retain the Iceberg snapshots. If an input is not provided, the corresponding Iceberg table configuration field will be used or if not present, the default value 5 will be used.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
numberOfSnapshotsToRetain
The number of Iceberg snapshots to retain within the retention period. If an input is not provided, the corresponding Iceberg table configuration field will be used or if not present, the default value 1 will be used.
- Parameters:
numberOfSnapshotsToRetain
- The number of Iceberg snapshots to retain within the retention period. If an input is not provided, the corresponding Iceberg table configuration field will be used or if not present, the default value 1 will be used.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cleanExpiredFiles
If set to false, snapshots are only deleted from table metadata, and the underlying data and metadata files are not deleted.
- Parameters:
cleanExpiredFiles
- If set to false, snapshots are only deleted from table metadata, and the underlying data and metadata files are not deleted.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
runRateInHours
The interval in hours between retention job runs. This parameter controls how frequently the retention optimizer will run to clean up expired snapshots. The value must be between 3 and 168 hours (7 days). If an input is not provided, the default value 24 will be used.
- Parameters:
runRateInHours
- The interval in hours between retention job runs. This parameter controls how frequently the retention optimizer will run to clean up expired snapshots. The value must be between 3 and 168 hours (7 days). If an input is not provided, the default value 24 will be used.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-