Package io.aiven.kafka.connect.common.config

Class CommonConfig

java.lang.Object
org.apache.kafka.common.config.AbstractConfig
io.aiven.kafka.connect.common.config.CommonConfig
Direct Known Subclasses:
SinkCommonConfig, SourceCommonConfig
public class CommonConfig extends org.apache.kafka.common.config.AbstractConfig
The base configuration or all connectors.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected static final String
    GROUP_COMPRESSION
     
    protected static final String
    GROUP_FORMAT
     
    static final String
    MAX_TASKS
     
    static final String
    TASK_ID
     

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    CommonConfig(org.apache.kafka.common.config.ConfigDef definition, Map<?,?> props)
    Constructs the CommonConfig with the backoff policy.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected static void
    addKafkaBackoffPolicy(org.apache.kafka.common.config.ConfigDef configDef)
    Deprecated.
    No longer needed.
    Long
    getKafkaRetryBackoffMs()
    Gets the Kafka retry backoff time in MS.
    int
    getMaxTasks()
    Get the maximum number of tasks that should be run by this connector configuration Max Tasks is set within the Kafka Connect framework and so is retrieved slightly differently in ConnectorConfig.java
    int
    getTaskId()
    Get the task id for this configuration

    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

  • Constructor Details

    • CommonConfig

      protected CommonConfig(org.apache.kafka.common.config.ConfigDef definition, Map<?,?> props)
      Constructs the CommonConfig with the backoff policy.
      Parameters:
      definition - the definition to add the backoff policy too.
      props - The properties to construct the configuration with.

  • Method Details

    • addKafkaBackoffPolicy

      @Deprecated protected static void addKafkaBackoffPolicy(org.apache.kafka.common.config.ConfigDef configDef)
      Deprecated.
      No longer needed.

    • getKafkaRetryBackoffMs

      public Long getKafkaRetryBackoffMs()
      Gets the Kafka retry backoff time in MS.
      Returns:
      The Kafka retry backoff time in MS.

    • getMaxTasks

      public int getMaxTasks()
      Get the maximum number of tasks that should be run by this connector configuration Max Tasks is set within the Kafka Connect framework and so is retrieved slightly differently in ConnectorConfig.java
      Returns:
      The maximum number of tasks that should be run by this connector configuration

    • getTaskId

      public int getTaskId()
      Get the task id for this configuration
      Returns:
      The task id for this configuration