Interface IcebergDestinationConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<IcebergDestinationConfiguration.Builder,IcebergDestinationConfiguration>, SdkBuilder<IcebergDestinationConfiguration.Builder,IcebergDestinationConfiguration>, SdkPojo

Enclosing class:

IcebergDestinationConfiguration

@Mutable
@NotThreadSafe
public static interface IcebergDestinationConfiguration.Builder
extends SdkPojo, CopyableBuilder<IcebergDestinationConfiguration.Builder,IcebergDestinationConfiguration>

Method Summary

Modifier and Type	Method	Description
IcebergDestinationConfiguration.Builder	appendOnly(Boolean appendOnly)	Whether the destination is append-only.
default IcebergDestinationConfiguration.Builder	catalog(Consumer<Catalog.Builder> catalog)	The AWS Glue Data Catalog and S3 Tables warehouse used by the destination.
IcebergDestinationConfiguration.Builder	catalog(Catalog catalog)	The AWS Glue Data Catalog and S3 Tables warehouse used by the destination.
IcebergDestinationConfiguration.Builder	compressionType(String compressionType)	The compression codec for Iceberg table data files.
IcebergDestinationConfiguration.Builder	compressionType(IcebergCompressionType compressionType)	The compression codec for Iceberg table data files.
IcebergDestinationConfiguration.Builder	dataFreshnessInSeconds(Integer dataFreshnessInSeconds)	The maximum time, in seconds, that records buffer in MSK before being flushed to the destination.
default IcebergDestinationConfiguration.Builder	deadLetterQueueS3(Consumer<DeadLetterQueueS3.Builder> deadLetterQueueS3)	The Amazon S3 bucket and prefix where MSK writes records that fail to deliver.
IcebergDestinationConfiguration.Builder	deadLetterQueueS3(DeadLetterQueueS3 deadLetterQueueS3)	The Amazon S3 bucket and prefix where MSK writes records that fail to deliver.
IcebergDestinationConfiguration.Builder	destinationTableList(Collection<DestinationTable> destinationTableList)	The destination Iceberg tables.
IcebergDestinationConfiguration.Builder	destinationTableList(Consumer<DestinationTable.Builder>... destinationTableList)	The destination Iceberg tables.
IcebergDestinationConfiguration.Builder	destinationTableList(DestinationTable... destinationTableList)	The destination Iceberg tables.
default IcebergDestinationConfiguration.Builder	schemaEvolution(Consumer<SchemaEvolution.Builder> schemaEvolution)	Configuration controlling whether the destination table's schema is evolved to match incoming records.
IcebergDestinationConfiguration.Builder	schemaEvolution(SchemaEvolution schemaEvolution)	Configuration controlling whether the destination table's schema is evolved to match incoming records.
IcebergDestinationConfiguration.Builder	serviceExecutionRoleArn(String serviceExecutionRoleArn)	The Amazon Resource Name (ARN) of the IAM role that MSK assumes to access the destination table, the AWS Glue Data Catalog, and the dead-letter Amazon S3 bucket.
default IcebergDestinationConfiguration.Builder	tableCreation(Consumer<TableCreation.Builder> tableCreation)	Configuration controlling whether MSK creates the destination table if it does not already exist.
IcebergDestinationConfiguration.Builder	tableCreation(TableCreation tableCreation)	Configuration controlling whether MSK creates the destination table if it does not already exist.

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

appendOnly

IcebergDestinationConfiguration.Builder appendOnly(Boolean appendOnly)

Whether the destination is append-only. Must be true; updates and deletes are not supported.

Parameters:

appendOnly - Whether the destination is append-only. Must be true; updates and deletes are not supported.

Returns:

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

catalog

IcebergDestinationConfiguration.Builder catalog(Catalog catalog)

The AWS Glue Data Catalog and S3 Tables warehouse used by the destination.

Parameters:

catalog - The AWS Glue Data Catalog and S3 Tables warehouse used by the destination.

Returns:

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

catalog

default IcebergDestinationConfiguration.Builder catalog(Consumer<Catalog.Builder> catalog)

The AWS Glue Data Catalog and S3 Tables warehouse used by the destination.

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

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

Parameters:

catalog - a consumer that will call methods on Catalog.Builder

Returns:

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

See Also:

• catalog(Catalog)

dataFreshnessInSeconds

IcebergDestinationConfiguration.Builder dataFreshnessInSeconds(Integer dataFreshnessInSeconds)

The maximum time, in seconds, that records buffer in MSK before being flushed to the destination. Allowed range: 300 to 900. Default: 600.

Parameters:

dataFreshnessInSeconds - The maximum time, in seconds, that records buffer in MSK before being flushed to the destination. Allowed range: 300 to 900. Default: 600.

Returns:

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

deadLetterQueueS3

IcebergDestinationConfiguration.Builder deadLetterQueueS3(DeadLetterQueueS3 deadLetterQueueS3)

The Amazon S3 bucket and prefix where MSK writes records that fail to deliver.

Parameters:

deadLetterQueueS3 - The Amazon S3 bucket and prefix where MSK writes records that fail to deliver.

Returns:

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

deadLetterQueueS3

default IcebergDestinationConfiguration.Builder deadLetterQueueS3(Consumer<DeadLetterQueueS3.Builder> deadLetterQueueS3)

The Amazon S3 bucket and prefix where MSK writes records that fail to deliver.

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

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

Parameters:

deadLetterQueueS3 - a consumer that will call methods on DeadLetterQueueS3.Builder

Returns:

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

See Also:

• deadLetterQueueS3(DeadLetterQueueS3)

destinationTableList

IcebergDestinationConfiguration.Builder destinationTableList(Collection<DestinationTable> destinationTableList)

The destination Iceberg tables. Currently exactly one table must be specified.

Parameters:

destinationTableList - The destination Iceberg tables. Currently exactly one table must be specified.

Returns:

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

destinationTableList

IcebergDestinationConfiguration.Builder destinationTableList(DestinationTable... destinationTableList)

The destination Iceberg tables. Currently exactly one table must be specified.

Parameters:

destinationTableList - The destination Iceberg tables. Currently exactly one table must be specified.

Returns:

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

destinationTableList

IcebergDestinationConfiguration.Builder destinationTableList(Consumer<DestinationTable.Builder>... destinationTableList)

The destination Iceberg tables. Currently exactly one table must be specified.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to destinationTableList(List<DestinationTable>).

Parameters:

destinationTableList - a consumer that will call methods on DestinationTable.Builder

Returns:

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

See Also:

• destinationTableList(java.util.Collection<DestinationTable>)

schemaEvolution

IcebergDestinationConfiguration.Builder schemaEvolution(SchemaEvolution schemaEvolution)

Configuration controlling whether the destination table's schema is evolved to match incoming records.

Parameters:

schemaEvolution - Configuration controlling whether the destination table's schema is evolved to match incoming records.

Returns:

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

schemaEvolution

default IcebergDestinationConfiguration.Builder schemaEvolution(Consumer<SchemaEvolution.Builder> schemaEvolution)

Configuration controlling whether the destination table's schema is evolved to match incoming records.

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

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

Parameters:

schemaEvolution - a consumer that will call methods on SchemaEvolution.Builder

Returns:

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

See Also:

• schemaEvolution(SchemaEvolution)

serviceExecutionRoleArn

IcebergDestinationConfiguration.Builder serviceExecutionRoleArn(String serviceExecutionRoleArn)

The Amazon Resource Name (ARN) of the IAM role that MSK assumes to access the destination table, the AWS Glue Data Catalog, and the dead-letter Amazon S3 bucket.

Parameters:

serviceExecutionRoleArn - The Amazon Resource Name (ARN) of the IAM role that MSK assumes to access the destination table, the AWS Glue Data Catalog, and the dead-letter Amazon S3 bucket.

Returns:

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

tableCreation

IcebergDestinationConfiguration.Builder tableCreation(TableCreation tableCreation)

Configuration controlling whether MSK creates the destination table if it does not already exist.

Parameters:

tableCreation - Configuration controlling whether MSK creates the destination table if it does not already exist.

Returns:

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

tableCreation

default IcebergDestinationConfiguration.Builder tableCreation(Consumer<TableCreation.Builder> tableCreation)

Configuration controlling whether MSK creates the destination table if it does not already exist.

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

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

Parameters:

tableCreation - a consumer that will call methods on TableCreation.Builder

Returns:

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

See Also:

• tableCreation(TableCreation)

compressionType

IcebergDestinationConfiguration.Builder compressionType(String compressionType)

The compression codec for Iceberg table data files. Defaults to ZSTD.

Parameters:

compressionType - The compression codec for Iceberg table data files. Defaults to ZSTD.

Returns:

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

See Also:

• IcebergCompressionType
• IcebergCompressionType

compressionType

IcebergDestinationConfiguration.Builder compressionType(IcebergCompressionType compressionType)

The compression codec for Iceberg table data files. Defaults to ZSTD.

Parameters:

compressionType - The compression codec for Iceberg table data files. Defaults to ZSTD.

Returns:

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

See Also:

• IcebergCompressionType
• IcebergCompressionType