Class IcebergDestinationConfiguration

java.lang.Object
software.amazon.awssdk.services.kafka.model.IcebergDestinationConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<IcebergDestinationConfiguration.Builder,IcebergDestinationConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class IcebergDestinationConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<IcebergDestinationConfiguration.Builder,IcebergDestinationConfiguration>

Configuration of an Apache Iceberg destination for a channel.

See Also:

  • Method Details

    • appendOnly

      public final Boolean appendOnly()

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

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

    • catalog

      public final Catalog catalog()

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

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

    • dataFreshnessInSeconds

      public final 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.

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

    • deadLetterQueueS3

      public final DeadLetterQueueS3 deadLetterQueueS3()

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

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

    • hasDestinationTableList

      public final boolean hasDestinationTableList()
      For responses, this returns true if the service returned a value for the DestinationTableList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • destinationTableList

      public final List<DestinationTable> destinationTableList()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDestinationTableList() method.

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

    • schemaEvolution

      public final SchemaEvolution schemaEvolution()

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

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

    • serviceExecutionRoleArn

      public final 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.

      Returns:
      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.

    • tableCreation

      public final TableCreation tableCreation()

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

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

    • compressionType

      public final IcebergCompressionType compressionType()

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

      If the service returns an enum value that is not available in the current SDK version, compressionType will return IcebergCompressionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from compressionTypeAsString().

      Returns:
      The compression codec for Iceberg table data files. Defaults to ZSTD.
      See Also:

    • compressionTypeAsString

      public final String compressionTypeAsString()

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

      If the service returns an enum value that is not available in the current SDK version, compressionType will return IcebergCompressionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from compressionTypeAsString().

      Returns:
      The compression codec for Iceberg table data files. Defaults to ZSTD.
      See Also:

    • toBuilder

      public IcebergDestinationConfiguration.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<IcebergDestinationConfiguration.Builder,IcebergDestinationConfiguration>
      Returns:
      a builder for type T

    • builder

      public static IcebergDestinationConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends IcebergDestinationConfiguration.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.