Interface IcebergMetadataProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
IcebergMetadataProperty.Jsii$Proxy
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
date="2026-04-02T21:55:36.204Z")
@Stability(Experimental)
public interface IcebergMetadataProperty
extends software.amazon.jsii.JsiiSerializable
(experimental) Contains details about the metadata for an Iceberg table.
Example:
// Build a table
Table sampleTable = Table.Builder.create(scope, "ExampleTable")
.tableName("example_table")
.namespace(namespace)
.openTableFormat(OpenTableFormat.ICEBERG)
.withoutMetadata(true)
.build();
// Build a table with an Iceberg Schema
Table sampleTableWithSchema = Table.Builder.create(scope, "ExampleSchemaTable")
.tableName("example_table_with_schema")
.namespace(namespace)
.openTableFormat(OpenTableFormat.ICEBERG)
.icebergMetadata(IcebergMetadataProperty.builder()
.icebergSchema(IcebergSchemaProperty.builder()
.schemaFieldList(List.of(SchemaFieldProperty.builder()
.name("id")
.type("int")
.required(true)
.build(), SchemaFieldProperty.builder()
.name("name")
.type("string")
.build()))
.build())
.build())
.compaction(CompactionProperty.builder()
.status(Status.ENABLED)
.targetFileSizeMb(128)
.build())
.snapshotManagement(SnapshotManagementProperty.builder()
.status(Status.ENABLED)
.maxSnapshotAgeHours(48)
.minSnapshotsToKeep(5)
.build())
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forIcebergMetadataPropertystatic final classAn implementation forIcebergMetadataProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default IcebergPartitionSpec(experimental) The partition specification for the Iceberg table.(experimental) Contains details about the schema for an Iceberg table.default IcebergSortOrder(experimental) The sort order for the Iceberg table.default List<TablePropertyEntry> (experimental) Custom properties for the Iceberg table.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getIcebergSchema
(experimental) Contains details about the schema for an Iceberg table.- See Also:
-
getIcebergPartitionSpec
(experimental) The partition specification for the Iceberg table.Default: - No partition specification
-
getIcebergSortOrder
(experimental) The sort order for the Iceberg table.Default: - No sort order
-
getTableProperties
(experimental) Custom properties for the Iceberg table.Each entry represents a key-value pair for Iceberg table configuration.
Default: - No custom properties
-
builder
- Returns:
- a
IcebergMetadataProperty.BuilderofIcebergMetadataProperty
-