Class IcebergRetentionConfiguration
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<IcebergRetentionConfiguration.Builder,IcebergRetentionConfiguration>
The configuration for an Iceberg snapshot retention optimizer.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()final BooleanIf set to false, snapshots are only deleted from table metadata, and the underlying data and metadata files are not deleted.final booleanfinal booleanequalsBySdkFields(Object obj) final <T> Optional<T>getValueForField(String fieldName, Class<T> clazz) final inthashCode()final IntegerThe number of Iceberg snapshots to retain within the retention period.final IntegerThe interval in hours between retention job runs.static Class<? extends IcebergRetentionConfiguration.Builder>final IntegerThe number of days to retain the Iceberg snapshots.final StringtoString()Returns a string representation of this object.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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:
- 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.
-
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:
- 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.
-
cleanExpiredFiles
If set to false, snapshots are only deleted from table metadata, and the underlying data and metadata files are not deleted.
- Returns:
- If set to false, snapshots are only deleted from table metadata, and the underlying data and metadata files are not deleted.
-
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:
- 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.
-
toBuilder
- Specified by:
toBuilderin interfaceToCopyableBuilder<IcebergRetentionConfiguration.Builder,IcebergRetentionConfiguration>
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-