org.apache.kafka.clients.consumer

Class ConsumerConfig

java.lang.Object

org.apache.kafka.common.config.AbstractConfig

org.apache.kafka.clients.consumer.ConsumerConfig

public class ConsumerConfig
extends AbstractConfig

The consumer configuration keys

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUTO_COMMIT_INTERVAL_MS_CONFIG auto.commit.interval.ms
static java.lang.String	AUTO_OFFSET_RESET_CONFIG auto.offset.reset
static java.lang.String	AUTO_OFFSET_RESET_DOC
static java.lang.String	BOOTSTRAP_SERVERS_CONFIG bootstrap.servers
static java.lang.String	CHECK_CRCS_CONFIG check.crcs
static java.lang.String	CLIENT_DNS_LOOKUP_CONFIG client.dns.lookup
static java.lang.String	CLIENT_ID_CONFIG client.id
static java.lang.String	CONNECTIONS_MAX_IDLE_MS_CONFIG connections.max.idle.ms
static java.lang.String	DEFAULT_API_TIMEOUT_MS_CONFIG default.api.timeout.ms
static java.lang.String	DEFAULT_API_TIMEOUT_MS_DOC
static boolean	DEFAULT_EXCLUDE_INTERNAL_TOPICS
static int	DEFAULT_FETCH_MAX_BYTES
static java.lang.String	DEFAULT_ISOLATION_LEVEL
static int	DEFAULT_MAX_PARTITION_FETCH_BYTES
static java.lang.String	ENABLE_AUTO_COMMIT_CONFIG enable.auto.commit
static java.lang.String	EXCLUDE_INTERNAL_TOPICS_CONFIG exclude.internal.topics
static java.lang.String	FETCH_MAX_BYTES_CONFIG fetch.max.bytes
static java.lang.String	FETCH_MAX_WAIT_MS_CONFIG fetch.max.wait.ms
static java.lang.String	FETCH_MIN_BYTES_CONFIG fetch.min.bytes
static java.lang.String	GROUP_ID_CONFIG group.id
static java.lang.String	HEARTBEAT_INTERVAL_MS_CONFIG heartbeat.interval.ms
static java.lang.String	INTERCEPTOR_CLASSES_CONFIG interceptor.classes
static java.lang.String	INTERCEPTOR_CLASSES_DOC
static java.lang.String	ISOLATION_LEVEL_CONFIG isolation.level
static java.lang.String	ISOLATION_LEVEL_DOC
static java.lang.String	KEY_DESERIALIZER_CLASS_CONFIG key.deserializer
static java.lang.String	KEY_DESERIALIZER_CLASS_DOC
static java.lang.String	MAX_PARTITION_FETCH_BYTES_CONFIG max.partition.fetch.bytes
static java.lang.String	MAX_POLL_INTERVAL_MS_CONFIG max.poll.interval.ms
static java.lang.String	MAX_POLL_RECORDS_CONFIG max.poll.records
static java.lang.String	METADATA_MAX_AGE_CONFIG metadata.max.age.ms
static java.lang.String	METRIC_REPORTER_CLASSES_CONFIG metric.reporters
static java.lang.String	METRICS_NUM_SAMPLES_CONFIG metrics.num.samples
static java.lang.String	METRICS_RECORDING_LEVEL_CONFIG metrics.log.level
static java.lang.String	METRICS_SAMPLE_WINDOW_MS_CONFIG metrics.sample.window.ms
static java.lang.String	PARTITION_ASSIGNMENT_STRATEGY_CONFIG partition.assignment.strategy
static java.lang.String	RECEIVE_BUFFER_CONFIG receive.buffer.bytes
static java.lang.String	RECONNECT_BACKOFF_MAX_MS_CONFIG reconnect.backoff.max.ms
static java.lang.String	RECONNECT_BACKOFF_MS_CONFIG reconnect.backoff.ms
static java.lang.String	REQUEST_TIMEOUT_MS_CONFIG request.timeout.ms
static java.lang.String	RETRY_BACKOFF_MS_CONFIG retry.backoff.ms
static java.lang.String	SEND_BUFFER_CONFIG send.buffer.bytes
static java.lang.String	SESSION_TIMEOUT_MS_CONFIG session.timeout.ms
static java.lang.String	VALUE_DESERIALIZER_CLASS_CONFIG value.deserializer
static java.lang.String	VALUE_DESERIALIZER_CLASS_DOC

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConsumerConfig(java.util.Map<?,?> props, boolean doLog)
	ConsumerConfig(java.util.Map<java.lang.String,java.lang.Object> props)
	ConsumerConfig(java.util.Properties props)

Method Summary

Modifier and Type	Method and Description
static java.util.Map<java.lang.String,java.lang.Object>	addDeserializerToConfig(java.util.Map<java.lang.String,java.lang.Object> configs, Deserializer<?> keyDeserializer, Deserializer<?> valueDeserializer)
static java.util.Properties	addDeserializerToConfig(java.util.Properties properties, Deserializer<?> keyDeserializer, Deserializer<?> valueDeserializer)
static java.util.Set<java.lang.String>	configNames()
static void	main(java.lang.String[] args)
protected java.util.Map<java.lang.String,java.lang.Object>	postProcessParsedConfig(java.util.Map<java.lang.String,java.lang.Object> parsedValues) Called directly after user configs got parsed (and thus default values got set).

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, typeOf, unused, values, valuesWithPrefixAllOrNothing, valuesWithPrefixOverride

Methods inherited from class java.lang.Object

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

Field Detail

GROUP_ID_CONFIG

public static final java.lang.String GROUP_ID_CONFIG

group.id

See Also:

Constant Field Values

MAX_POLL_RECORDS_CONFIG

public static final java.lang.String MAX_POLL_RECORDS_CONFIG

max.poll.records

See Also:

Constant Field Values

MAX_POLL_INTERVAL_MS_CONFIG

public static final java.lang.String MAX_POLL_INTERVAL_MS_CONFIG

max.poll.interval.ms

See Also:

Constant Field Values

SESSION_TIMEOUT_MS_CONFIG

public static final java.lang.String SESSION_TIMEOUT_MS_CONFIG

session.timeout.ms

See Also:

Constant Field Values

HEARTBEAT_INTERVAL_MS_CONFIG

public static final java.lang.String HEARTBEAT_INTERVAL_MS_CONFIG

heartbeat.interval.ms

See Also:

Constant Field Values

BOOTSTRAP_SERVERS_CONFIG

public static final java.lang.String BOOTSTRAP_SERVERS_CONFIG

bootstrap.servers

See Also:

Constant Field Values

CLIENT_DNS_LOOKUP_CONFIG

public static final java.lang.String CLIENT_DNS_LOOKUP_CONFIG

client.dns.lookup

See Also:

Constant Field Values

ENABLE_AUTO_COMMIT_CONFIG

public static final java.lang.String ENABLE_AUTO_COMMIT_CONFIG

enable.auto.commit

See Also:

Constant Field Values

AUTO_COMMIT_INTERVAL_MS_CONFIG

public static final java.lang.String AUTO_COMMIT_INTERVAL_MS_CONFIG

auto.commit.interval.ms

See Also:

Constant Field Values

PARTITION_ASSIGNMENT_STRATEGY_CONFIG

public static final java.lang.String PARTITION_ASSIGNMENT_STRATEGY_CONFIG

partition.assignment.strategy

See Also:

Constant Field Values

AUTO_OFFSET_RESET_CONFIG

public static final java.lang.String AUTO_OFFSET_RESET_CONFIG

auto.offset.reset

See Also:

Constant Field Values

AUTO_OFFSET_RESET_DOC

public static final java.lang.String AUTO_OFFSET_RESET_DOC

See Also:

Constant Field Values

FETCH_MIN_BYTES_CONFIG

public static final java.lang.String FETCH_MIN_BYTES_CONFIG

fetch.min.bytes

See Also:

Constant Field Values

FETCH_MAX_BYTES_CONFIG

public static final java.lang.String FETCH_MAX_BYTES_CONFIG

fetch.max.bytes

See Also:

Constant Field Values

DEFAULT_FETCH_MAX_BYTES

public static final int DEFAULT_FETCH_MAX_BYTES

See Also:

Constant Field Values

FETCH_MAX_WAIT_MS_CONFIG

public static final java.lang.String FETCH_MAX_WAIT_MS_CONFIG

fetch.max.wait.ms

See Also:

Constant Field Values

METADATA_MAX_AGE_CONFIG

public static final java.lang.String METADATA_MAX_AGE_CONFIG

metadata.max.age.ms

See Also:

Constant Field Values

MAX_PARTITION_FETCH_BYTES_CONFIG

public static final java.lang.String MAX_PARTITION_FETCH_BYTES_CONFIG

max.partition.fetch.bytes

See Also:

Constant Field Values

DEFAULT_MAX_PARTITION_FETCH_BYTES

public static final int DEFAULT_MAX_PARTITION_FETCH_BYTES

See Also:

Constant Field Values

SEND_BUFFER_CONFIG

public static final java.lang.String SEND_BUFFER_CONFIG

send.buffer.bytes

See Also:

Constant Field Values

RECEIVE_BUFFER_CONFIG

public static final java.lang.String RECEIVE_BUFFER_CONFIG

receive.buffer.bytes

See Also:

Constant Field Values

CLIENT_ID_CONFIG

public static final java.lang.String CLIENT_ID_CONFIG

client.id

See Also:

Constant Field Values

RECONNECT_BACKOFF_MS_CONFIG

public static final java.lang.String RECONNECT_BACKOFF_MS_CONFIG

reconnect.backoff.ms

See Also:

Constant Field Values

RECONNECT_BACKOFF_MAX_MS_CONFIG

public static final java.lang.String RECONNECT_BACKOFF_MAX_MS_CONFIG

reconnect.backoff.max.ms

See Also:

Constant Field Values

RETRY_BACKOFF_MS_CONFIG

public static final java.lang.String RETRY_BACKOFF_MS_CONFIG

retry.backoff.ms

See Also:

Constant Field Values

METRICS_SAMPLE_WINDOW_MS_CONFIG

public static final java.lang.String METRICS_SAMPLE_WINDOW_MS_CONFIG

metrics.sample.window.ms

See Also:

Constant Field Values

METRICS_NUM_SAMPLES_CONFIG

public static final java.lang.String METRICS_NUM_SAMPLES_CONFIG

metrics.num.samples

See Also:

Constant Field Values

METRICS_RECORDING_LEVEL_CONFIG

public static final java.lang.String METRICS_RECORDING_LEVEL_CONFIG

metrics.log.level

See Also:

Constant Field Values

METRIC_REPORTER_CLASSES_CONFIG

public static final java.lang.String METRIC_REPORTER_CLASSES_CONFIG

metric.reporters

See Also:

Constant Field Values

CHECK_CRCS_CONFIG

public static final java.lang.String CHECK_CRCS_CONFIG

check.crcs

See Also:

Constant Field Values

KEY_DESERIALIZER_CLASS_CONFIG

public static final java.lang.String KEY_DESERIALIZER_CLASS_CONFIG

key.deserializer

See Also:

Constant Field Values

KEY_DESERIALIZER_CLASS_DOC

public static final java.lang.String KEY_DESERIALIZER_CLASS_DOC

See Also:

Constant Field Values

VALUE_DESERIALIZER_CLASS_CONFIG

public static final java.lang.String VALUE_DESERIALIZER_CLASS_CONFIG

value.deserializer

See Also:

Constant Field Values

VALUE_DESERIALIZER_CLASS_DOC

public static final java.lang.String VALUE_DESERIALIZER_CLASS_DOC

See Also:

Constant Field Values

CONNECTIONS_MAX_IDLE_MS_CONFIG

public static final java.lang.String CONNECTIONS_MAX_IDLE_MS_CONFIG

connections.max.idle.ms

See Also:

Constant Field Values

REQUEST_TIMEOUT_MS_CONFIG

public static final java.lang.String REQUEST_TIMEOUT_MS_CONFIG

request.timeout.ms

See Also:

Constant Field Values

DEFAULT_API_TIMEOUT_MS_CONFIG

public static final java.lang.String DEFAULT_API_TIMEOUT_MS_CONFIG

default.api.timeout.ms

See Also:

Constant Field Values

DEFAULT_API_TIMEOUT_MS_DOC

public static final java.lang.String DEFAULT_API_TIMEOUT_MS_DOC

See Also:

Constant Field Values

INTERCEPTOR_CLASSES_CONFIG

public static final java.lang.String INTERCEPTOR_CLASSES_CONFIG

interceptor.classes

See Also:

Constant Field Values

INTERCEPTOR_CLASSES_DOC

public static final java.lang.String INTERCEPTOR_CLASSES_DOC

See Also:

Constant Field Values

EXCLUDE_INTERNAL_TOPICS_CONFIG

public static final java.lang.String EXCLUDE_INTERNAL_TOPICS_CONFIG

exclude.internal.topics

See Also:

Constant Field Values

DEFAULT_EXCLUDE_INTERNAL_TOPICS

public static final boolean DEFAULT_EXCLUDE_INTERNAL_TOPICS

See Also:

Constant Field Values

ISOLATION_LEVEL_CONFIG

public static final java.lang.String ISOLATION_LEVEL_CONFIG

isolation.level

See Also:

Constant Field Values

ISOLATION_LEVEL_DOC

public static final java.lang.String ISOLATION_LEVEL_DOC

See Also:

Constant Field Values

DEFAULT_ISOLATION_LEVEL

public static final java.lang.String DEFAULT_ISOLATION_LEVEL

Constructor Detail

ConsumerConfig

public ConsumerConfig(java.util.Properties props)

ConsumerConfig

public ConsumerConfig(java.util.Map<java.lang.String,java.lang.Object> props)

ConsumerConfig

protected ConsumerConfig(java.util.Map<?,?> props,
                         boolean doLog)

Method Detail

postProcessParsedConfig

protected java.util.Map<java.lang.String,java.lang.Object> postProcessParsedConfig(java.util.Map<java.lang.String,java.lang.Object> parsedValues)

Description copied from class: AbstractConfig

Called directly after user configs got parsed (and thus default values got set). This allows to change default values for "secondary defaults" if required.

Overrides:

postProcessParsedConfig in class AbstractConfig

Parameters:

parsedValues - unmodifiable map of current configuration

Returns:

a map of updates that should be applied to the configuration (will be validated to prevent bad updates)

addDeserializerToConfig

public static java.util.Map<java.lang.String,java.lang.Object> addDeserializerToConfig(java.util.Map<java.lang.String,java.lang.Object> configs,
                                                                                       Deserializer<?> keyDeserializer,
                                                                                       Deserializer<?> valueDeserializer)

addDeserializerToConfig

public static java.util.Properties addDeserializerToConfig(java.util.Properties properties,
                                                           Deserializer<?> keyDeserializer,
                                                           Deserializer<?> valueDeserializer)

configNames

public static java.util.Set<java.lang.String> configNames()

main

public static void main(java.lang.String[] args)