Package io.aiven.kafka.connect.s3.config

Class S3SinkConfig

java.lang.Object
org.apache.kafka.common.config.AbstractConfig
io.aiven.kafka.connect.common.config.CommonConfig
io.aiven.kafka.connect.common.config.SinkCommonConfig
io.aiven.kafka.connect.config.s3.S3SinkBaseConfig
io.aiven.kafka.connect.s3.config.S3SinkConfig
public final class S3SinkConfig extends io.aiven.kafka.connect.config.s3.S3SinkBaseConfig

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    protected static class 
    S3SinkConfig.AwsRegionValidator
    Deprecated.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    AWS_S3_RETRY_BACKOFF_DELAY_MS_DEFAULT
     
    static final int
    AWS_S3_RETRY_BACKOFF_MAX_DELAY_MS_DEFAULT
     
    static final org.slf4j.Logger
    LOGGER
     
    static final int
    S3_RETRY_BACKOFF_MAX_RETRIES_DEFAULT
     

    Fields inherited from class io.aiven.kafka.connect.common.config.SinkCommonConfig

    FILE_COMPRESSION_TYPE_CONFIG, FILE_MAX_RECORDS, FILE_NAME_TEMPLATE_CONFIG, fileNameFragment, outputFormatFragment

    Fields inherited from class io.aiven.kafka.connect.common.config.CommonConfig

    GROUP_COMPRESSION, GROUP_FORMAT, MAX_TASKS, TASK_ID

  • Constructor Summary

    Constructors
    Constructor
    Description
    S3SinkConfig(Map<String,String> properties)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static org.apache.kafka.common.config.ConfigDef
    configDef()
     
    io.aiven.kafka.connect.common.config.CompressionType
    getCompressionType()
     
    List<io.aiven.kafka.connect.common.config.OutputField>
    getOutputFields()
    Gets the list of output fields.
    List<io.aiven.kafka.connect.common.config.OutputField>
    getOutputFields(String format)
    Deprecated.
    io.aiven.kafka.connect.common.templating.Template
    getPrefixTemplate()
     
    io.aiven.kafka.connect.common.config.TimestampSource
    getTimestampSource()
     
    ZoneId
    getTimezone()
     
    Boolean
    usesFileNameTemplate()
     

    Methods inherited from class io.aiven.kafka.connect.config.s3.S3SinkBaseConfig

    addAwsConfigGroup, addAwsStsConfigGroup, addDeprecatedConfiguration, addS3RetryPolicies, getAwsCredentials, getAwsEndpointConfiguration, getAwsS3BucketName, getAwsS3EndPoint, getAwsS3PartSize, getAwsS3Prefix, getAwsS3Region, getCustomCredentialsProvider, getS3RetryBackoffDelayMs, getS3RetryBackoffMaxDelayMs, getS3RetryBackoffMaxRetries, getServerSideEncryptionAlgorithmName, getStsEndpointConfig, getStsRole, hasAwsStsRole, hasStsEndpointConfig

    Methods inherited from class io.aiven.kafka.connect.common.config.SinkCommonConfig

    addCompressionTypeConfig, addOutputFieldsFormatConfigGroup, envelopeEnabled, getFilename, getFilenameTemplate, getFilenameTimestampSource, getFilenameTimezone, getFormatType, getMaxRecordsPerFile, getOutputFieldEncodingType

    Methods inherited from class io.aiven.kafka.connect.common.config.CommonConfig

    addKafkaBackoffPolicy, getKafkaRetryBackoffMs, getMaxTasks, getTaskId

    Methods inherited from class org.apache.kafka.common.config.AbstractConfig

    equals, get, getBoolean, getClass, getConfiguredInstance, getConfiguredInstances, getConfiguredInstances, getConfiguredInstances, getDouble, getInt, getList, getLong, getPassword, getShort, getString, hashCode, ignore, logUnused, originals, originalsStrings, originalsWithPrefix, originalsWithPrefix, postProcessParsedConfig, typeOf, unused, values, valuesWithPrefixAllOrNothing, valuesWithPrefixOverride

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • LOGGER

      public static final org.slf4j.Logger LOGGER

    • AWS_S3_RETRY_BACKOFF_DELAY_MS_DEFAULT

      public static final int AWS_S3_RETRY_BACKOFF_DELAY_MS_DEFAULT
      See Also:

    • AWS_S3_RETRY_BACKOFF_MAX_DELAY_MS_DEFAULT

      public static final int AWS_S3_RETRY_BACKOFF_MAX_DELAY_MS_DEFAULT
      See Also:

    • S3_RETRY_BACKOFF_MAX_RETRIES_DEFAULT

      public static final int S3_RETRY_BACKOFF_MAX_RETRIES_DEFAULT
      See Also:

  • Constructor Details

  • Method Details

    • configDef

      public static org.apache.kafka.common.config.ConfigDef configDef()

    • getCompressionType

      public io.aiven.kafka.connect.common.config.CompressionType getCompressionType()
      Overrides:
      getCompressionType in class io.aiven.kafka.connect.common.config.SinkCommonConfig

    • getOutputFields

      public List<io.aiven.kafka.connect.common.config.OutputField> getOutputFields()
      Gets the list of output fields. Will check {OutputFormatFragment#FORMAT_OUTPUT_FIELDS_CONFIG} and then {OutputFormatFragment#OUTPUT_FIELDS}. If neither is set will create an output field of OutputFieldType.VALUE and OutputFieldEncodingType.BASE64.
      Overrides:
      getOutputFields in class io.aiven.kafka.connect.common.config.SinkCommonConfig
      Returns:
      The list of output fields. WIll not be null.

    • getOutputFields

      @Deprecated public List<io.aiven.kafka.connect.common.config.OutputField> getOutputFields(String format)
      Deprecated.
      Gets the list of output fields for the specified name Deprecated please use getOutputFields()
      Parameters:
      format - the name of the configuration key to check.
      Returns:
      a list of output fields as defined in the configuration or null if not defined.

    • getPrefixTemplate

      public io.aiven.kafka.connect.common.templating.Template getPrefixTemplate()

    • getTimezone

      public ZoneId getTimezone()

    • getTimestampSource

      public io.aiven.kafka.connect.common.config.TimestampSource getTimestampSource()

    • usesFileNameTemplate

      public Boolean usesFileNameTemplate()