Class IcebergDestinationUpdate

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

Describes an update for a destination in Apache Iceberg Tables.

See Also:

  • Method Details

    • hasDestinationTableConfigurationList

      public final boolean hasDestinationTableConfigurationList()
      For responses, this returns true if the service returned a value for the DestinationTableConfigurationList 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.

    • destinationTableConfigurationList

      public final List<DestinationTableConfiguration> destinationTableConfigurationList()

      Provides a list of DestinationTableConfigurations which Firehose uses to deliver data to Apache Iceberg Tables. Firehose will write data with insert if table specific configuration is not provided here.

      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 hasDestinationTableConfigurationList() method.

      Returns:
      Provides a list of DestinationTableConfigurations which Firehose uses to deliver data to Apache Iceberg Tables. Firehose will write data with insert if table specific configuration is not provided here.

    • schemaEvolutionConfiguration

      public final SchemaEvolutionConfiguration schemaEvolutionConfiguration()

      The configuration to enable automatic schema evolution.

      Amazon Data Firehose is in preview release and is subject to change.

      Returns:
      The configuration to enable automatic schema evolution.

      Amazon Data Firehose is in preview release and is subject to change.

    • tableCreationConfiguration

      public final TableCreationConfiguration tableCreationConfiguration()

      The configuration to enable automatic table creation.

      Amazon Data Firehose is in preview release and is subject to change.

      Returns:
      The configuration to enable automatic table creation.

      Amazon Data Firehose is in preview release and is subject to change.

    • bufferingHints

      public final BufferingHints bufferingHints()
      Returns the value of the BufferingHints property for this object.
      Returns:
      The value of the BufferingHints property for this object.

    • cloudWatchLoggingOptions

      public final CloudWatchLoggingOptions cloudWatchLoggingOptions()
      Returns the value of the CloudWatchLoggingOptions property for this object.
      Returns:
      The value of the CloudWatchLoggingOptions property for this object.

    • processingConfiguration

      public final ProcessingConfiguration processingConfiguration()
      Returns the value of the ProcessingConfiguration property for this object.
      Returns:
      The value of the ProcessingConfiguration property for this object.

    • s3BackupMode

      public final IcebergS3BackupMode s3BackupMode()

      Describes how Firehose will backup records. Currently,Firehose only supports FailedDataOnly.

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

      Returns:
      Describes how Firehose will backup records. Currently,Firehose only supports FailedDataOnly.
      See Also:

    • s3BackupModeAsString

      public final String s3BackupModeAsString()

      Describes how Firehose will backup records. Currently,Firehose only supports FailedDataOnly.

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

      Returns:
      Describes how Firehose will backup records. Currently,Firehose only supports FailedDataOnly.
      See Also:

    • retryOptions

      public final RetryOptions retryOptions()
      Returns the value of the RetryOptions property for this object.
      Returns:
      The value of the RetryOptions property for this object.

    • roleARN

      public final String roleARN()

      The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling Apache Iceberg Tables.

      Returns:
      The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling Apache Iceberg Tables.

    • appendOnly

      public final Boolean appendOnly()

      Describes whether all incoming data for this delivery stream will be append only (inserts only and not for updates and deletes) for Iceberg delivery. This feature is only applicable for Apache Iceberg Tables.

      The default value is false. If you set this value to true, Firehose automatically increases the throughput limit of a stream based on the throttling levels of the stream. If you set this parameter to true for a stream with updates and deletes, you will see out of order delivery.

      Returns:
      Describes whether all incoming data for this delivery stream will be append only (inserts only and not for updates and deletes) for Iceberg delivery. This feature is only applicable for Apache Iceberg Tables.

      The default value is false. If you set this value to true, Firehose automatically increases the throughput limit of a stream based on the throttling levels of the stream. If you set this parameter to true for a stream with updates and deletes, you will see out of order delivery.

    • catalogConfiguration

      public final CatalogConfiguration catalogConfiguration()

      Configuration describing where the destination Iceberg tables are persisted.

      Returns:
      Configuration describing where the destination Iceberg tables are persisted.

    • s3Configuration

      public final S3DestinationConfiguration s3Configuration()
      Returns the value of the S3Configuration property for this object.
      Returns:
      The value of the S3Configuration property for this object.

    • toBuilder

      public IcebergDestinationUpdate.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<IcebergDestinationUpdate.Builder,IcebergDestinationUpdate>
      Returns:
      a builder for type T

    • builder

      public static IcebergDestinationUpdate.Builder builder()

    • serializableBuilderClass

      public static Class<? extends IcebergDestinationUpdate.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.