Package io.aiven.commons.kafka.connector.source.config

Class SourceCommonConfig

java.lang.Object

org.apache.kafka.common.config.AbstractConfig

io.aiven.commons.kafka.config.CommonConfig

io.aiven.commons.kafka.connector.common.config.ConnectorCommonConfig

io.aiven.commons.kafka.connector.source.config.SourceCommonConfig

public class SourceCommonConfig
extends ConnectorCommonConfig

The common definitions for source connectors.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SourceCommonConfig.SourceCommonConfigDef	The common source configuration definition.

Nested classes/interfaces inherited from class io.aiven.commons.kafka.config.CommonConfig

io.aiven.commons.kafka.config.CommonConfig.ChangeTrackingMap

Field Summary

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

AUTOMATIC_CONFIG_PROVIDERS_PROPERTY, CONFIG_PROVIDERS_CONFIG

Constructor Summary

Constructors

Constructor	Description
SourceCommonConfig(SourceCommonConfig.SourceCommonConfigDef definition, Map<String,String> originals)	Constructor.

Method Summary

Modifier and Type	Method	Description
List<String>	getCsvExtractorHeader()	Gets the specified headers, if any, for the CSV extractor.
DistributionType	getDistributionType()	Gets the distribution type.
org.apache.kafka.connect.runtime.errors.ToleranceType	getErrorsTolerance()	Gets the tolerance for errors.
Extractor	getExtractor()	Gets the extractor defined for this source.
int	getExtractorBufferSize()	Gets the size of the Extractor buffer if the extractor builds a buffered input stream.
int	getExtractorCacheSize()	Gets the size of the Extractor cache if the extractor supports a cache.
int	getMaxPollRecords()	Gets the maximum number of records to return in a single poll.
String	getNativeStartKey()	Gets the native start key for the initial file to scan.
int	getRingBufferSize()	Gets the size of the ring buffer used to track read files.
String	getTargetTopic()	Gets the target topic to write messages to.
boolean	isCsvExtractorHeaderEnabled()	Gets the CSV header enabled flag.

Methods inherited from class io.aiven.commons.kafka.connector.common.config.ConnectorCommonConfig

fragmentPostProcess, getCompressionType, getKeyConverterSchemaRegistryUrl, getSchemaRegistryUrl, getValueConverterSchemaRegistryUrl, isKeyConverterRegistryEnabled, isSchemaRegistryEnabled, isValueConverterRegistryEnabled

Methods inherited from class io.aiven.commons.kafka.config.CommonConfig

finalize, getKafkaRetryBackoffMs, getMaxTasks, getTaskId, postProcessParsedConfig

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

SourceCommonConfig

public SourceCommonConfig(SourceCommonConfig.SourceCommonConfigDef definition,
 Map<String,String> originals)

Constructor.

Parameters:

definition - the configuration definition.

originals - the initial configuration data.

Method Details

getTargetTopic

public String getTargetTopic()

Gets the target topic to write messages to.

Returns:

the target topic to write messages to.

getErrorsTolerance

public org.apache.kafka.connect.runtime.errors.ToleranceType getErrorsTolerance()

Gets the tolerance for errors.

Returns:

the tolerance for errors.

getDistributionType

public DistributionType getDistributionType()

Gets the distribution type.

Returns:

the distribution type.

getMaxPollRecords

public int getMaxPollRecords()

Gets the maximum number of records to return in a single poll.

Returns:

the maximum number of records to return in a single poll.

getNativeStartKey

public String getNativeStartKey()

Gets the native start key for the initial file to scan.

Returns:

the native start key.

getRingBufferSize

public int getRingBufferSize()

Gets the size of the ring buffer used to track read files.

Returns:

the size of the ring buffer.

getExtractor

public Extractor getExtractor()

Gets the extractor defined for this source.

Returns:

the Extractor defined for this source.

getExtractorBufferSize

public int getExtractorBufferSize()

Gets the size of the Extractor buffer if the extractor builds a buffered input stream.

Returns:

the size of the extractor buffer in bytes.

getExtractorCacheSize

public int getExtractorCacheSize()

Gets the size of the Extractor cache if the extractor supports a cache.

Returns:

the size of the extractor cache in bytes.

isCsvExtractorHeaderEnabled

public boolean isCsvExtractorHeaderEnabled()

Gets the CSV header enabled flag.

Returns:

true if headers should be extracted from the CSV input, false otherwise.

getCsvExtractorHeader

public List<String> getCsvExtractorHeader()

Gets the specified headers, if any, for the CSV extractor.

Returns:

list of headers specified for the CSV extractor.