Package 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	Description
static final String	ALLOW_AUTO_CREATE_TOPICS_CONFIG	allow.auto.create.topics
static final List<String>	ASSIGN_FROM_SUBSCRIBED_ASSIGNORS
static final String	AUTO_COMMIT_INTERVAL_MS_CONFIG	auto.commit.interval.ms
static final String	AUTO_OFFSET_RESET_CONFIG	auto.offset.reset
static final String	AUTO_OFFSET_RESET_DOC
static final String	BOOTSTRAP_SERVERS_CONFIG	bootstrap.servers
static final String	CHECK_CRCS_CONFIG	check.crcs
static final String	CLIENT_DNS_LOOKUP_CONFIG	client.dns.lookup
static final String	CLIENT_ID_CONFIG	client.id
static final String	CLIENT_RACK_CONFIG	client.rack
static final String	CONNECTIONS_MAX_IDLE_MS_CONFIG	connections.max.idle.ms
static final boolean	DEFAULT_ALLOW_AUTO_CREATE_TOPICS
static final String	DEFAULT_API_TIMEOUT_MS_CONFIG	default.api.timeout.ms
static final String	DEFAULT_CLIENT_RACK
static final boolean	DEFAULT_EXCLUDE_INTERNAL_TOPICS
static final int	DEFAULT_FETCH_MAX_BYTES
static final int	DEFAULT_FETCH_MAX_WAIT_MS
static final int	DEFAULT_FETCH_MIN_BYTES
static final String	DEFAULT_GROUP_PROTOCOL
static final String	DEFAULT_GROUP_REMOTE_ASSIGNOR
static final String	DEFAULT_ISOLATION_LEVEL
static final int	DEFAULT_MAX_PARTITION_FETCH_BYTES
static final int	DEFAULT_MAX_POLL_RECORDS
static final String	ENABLE_AUTO_COMMIT_CONFIG	enable.auto.commit
static final String	ENABLE_METRICS_PUSH_CONFIG	enable.metrics.push
static final String	ENABLE_METRICS_PUSH_DOC
static final String	EXCLUDE_INTERNAL_TOPICS_CONFIG	exclude.internal.topics
static final String	FETCH_MAX_BYTES_CONFIG	fetch.max.bytes
static final String	FETCH_MAX_WAIT_MS_CONFIG	fetch.max.wait.ms
static final String	FETCH_MIN_BYTES_CONFIG	fetch.min.bytes
static final String	GROUP_ID_CONFIG	group.id
static final String	GROUP_INSTANCE_ID_CONFIG	group.instance.id
static final String	GROUP_PROTOCOL_CONFIG	group.protocol
static final String	GROUP_PROTOCOL_DOC
static final String	GROUP_REMOTE_ASSIGNOR_CONFIG	group.remote.assignor
static final String	GROUP_REMOTE_ASSIGNOR_DOC
static final String	HEARTBEAT_INTERVAL_MS_CONFIG	heartbeat.interval.ms
static final String	INTERCEPTOR_CLASSES_CONFIG	interceptor.classes
static final String	INTERCEPTOR_CLASSES_DOC
static final String	ISOLATION_LEVEL_CONFIG	isolation.level
static final String	ISOLATION_LEVEL_DOC
static final String	KEY_DESERIALIZER_CLASS_CONFIG	key.deserializer
static final String	KEY_DESERIALIZER_CLASS_DOC
static final String	MAX_PARTITION_FETCH_BYTES_CONFIG	max.partition.fetch.bytes
static final String	MAX_POLL_INTERVAL_MS_CONFIG	max.poll.interval.ms
static final String	MAX_POLL_RECORDS_CONFIG	max.poll.records
static final String	METADATA_MAX_AGE_CONFIG	metadata.max.age.ms
static final String	METRIC_REPORTER_CLASSES_CONFIG	metric.reporters
static final String	METRICS_NUM_SAMPLES_CONFIG	metrics.num.samples
static final String	METRICS_RECORDING_LEVEL_CONFIG	metrics.log.level
static final String	METRICS_SAMPLE_WINDOW_MS_CONFIG	metrics.sample.window.ms
static final String	PARTITION_ASSIGNMENT_STRATEGY_CONFIG	partition.assignment.strategy
static final String	RECEIVE_BUFFER_CONFIG	receive.buffer.bytes
static final String	RECONNECT_BACKOFF_MAX_MS_CONFIG	reconnect.backoff.max.ms
static final String	RECONNECT_BACKOFF_MS_CONFIG	reconnect.backoff.ms
static final String	REQUEST_TIMEOUT_MS_CONFIG	request.timeout.ms
static final String	RETRY_BACKOFF_MAX_MS_CONFIG	retry.backoff.max.ms
static final String	RETRY_BACKOFF_MS_CONFIG	retry.backoff.ms
static final String	SECURITY_PROVIDERS_CONFIG	security.providers
static final String	SEND_BUFFER_CONFIG	send.buffer.bytes
static final String	SESSION_TIMEOUT_MS_CONFIG	session.timeout.ms
static final String	SOCKET_CONNECTION_SETUP_TIMEOUT_MAX_MS_CONFIG	socket.connection.setup.timeout.max.ms
static final String	SOCKET_CONNECTION_SETUP_TIMEOUT_MS_CONFIG	socket.connection.setup.timeout.ms
static final String	VALUE_DESERIALIZER_CLASS_CONFIG	value.deserializer
static final String	VALUE_DESERIALIZER_CLASS_DOC

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

AUTOMATIC_CONFIG_PROVIDERS_PROPERTY, CONFIG_PROVIDERS_CONFIG

Constructor Summary

Constructors

Constructor	Description
ConsumerConfig(Map<String,Object> props)
ConsumerConfig(Properties props)

Method Summary

Modifier and Type	Method	Description
static Map<String,Object>	appendDeserializerToConfig(Map<String,Object> configs, Deserializer<?> keyDeserializer, Deserializer<?> valueDeserializer)
static ConfigDef	configDef()
static Set<String>	configNames()
static void	main(String[] args)

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

documentationOf, equals, 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

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

Field Details

ASSIGN_FROM_SUBSCRIBED_ASSIGNORS

public static final List<String> ASSIGN_FROM_SUBSCRIBED_ASSIGNORS

GROUP_ID_CONFIG

public static final String GROUP_ID_CONFIG

group.id

See Also:

• Constant Field Values

GROUP_INSTANCE_ID_CONFIG

public static final String GROUP_INSTANCE_ID_CONFIG

group.instance.id

See Also:

• Constant Field Values

MAX_POLL_RECORDS_CONFIG

public static final String MAX_POLL_RECORDS_CONFIG

max.poll.records

See Also:

• Constant Field Values

DEFAULT_MAX_POLL_RECORDS

public static final int DEFAULT_MAX_POLL_RECORDS

See Also:

• Constant Field Values

MAX_POLL_INTERVAL_MS_CONFIG

public static final String MAX_POLL_INTERVAL_MS_CONFIG

max.poll.interval.ms

See Also:

• Constant Field Values

SESSION_TIMEOUT_MS_CONFIG

public static final String SESSION_TIMEOUT_MS_CONFIG

session.timeout.ms

See Also:

• Constant Field Values

HEARTBEAT_INTERVAL_MS_CONFIG

public static final String HEARTBEAT_INTERVAL_MS_CONFIG

heartbeat.interval.ms

See Also:

• Constant Field Values

GROUP_PROTOCOL_CONFIG

public static final String GROUP_PROTOCOL_CONFIG

group.protocol

See Also:

• Constant Field Values

DEFAULT_GROUP_PROTOCOL

public static final String DEFAULT_GROUP_PROTOCOL

GROUP_PROTOCOL_DOC

public static final String GROUP_PROTOCOL_DOC

See Also:

• Constant Field Values

GROUP_REMOTE_ASSIGNOR_CONFIG

public static final String GROUP_REMOTE_ASSIGNOR_CONFIG

group.remote.assignor

See Also:

• Constant Field Values

DEFAULT_GROUP_REMOTE_ASSIGNOR

public static final String DEFAULT_GROUP_REMOTE_ASSIGNOR

GROUP_REMOTE_ASSIGNOR_DOC

public static final String GROUP_REMOTE_ASSIGNOR_DOC

See Also:

• Constant Field Values

BOOTSTRAP_SERVERS_CONFIG

public static final String BOOTSTRAP_SERVERS_CONFIG

bootstrap.servers

See Also:

• Constant Field Values

CLIENT_DNS_LOOKUP_CONFIG

public static final String CLIENT_DNS_LOOKUP_CONFIG

client.dns.lookup

See Also:

• Constant Field Values

ENABLE_AUTO_COMMIT_CONFIG

public static final String ENABLE_AUTO_COMMIT_CONFIG

enable.auto.commit

See Also:

• Constant Field Values

AUTO_COMMIT_INTERVAL_MS_CONFIG

public static final String AUTO_COMMIT_INTERVAL_MS_CONFIG

auto.commit.interval.ms

See Also:

• Constant Field Values

PARTITION_ASSIGNMENT_STRATEGY_CONFIG

public static final String PARTITION_ASSIGNMENT_STRATEGY_CONFIG

partition.assignment.strategy

See Also:

• Constant Field Values

AUTO_OFFSET_RESET_CONFIG

public static final String AUTO_OFFSET_RESET_CONFIG

auto.offset.reset

See Also:

• Constant Field Values

AUTO_OFFSET_RESET_DOC

public static final String AUTO_OFFSET_RESET_DOC

See Also:

• Constant Field Values

FETCH_MIN_BYTES_CONFIG

public static final String FETCH_MIN_BYTES_CONFIG

fetch.min.bytes

See Also:

• Constant Field Values

DEFAULT_FETCH_MIN_BYTES

public static final int DEFAULT_FETCH_MIN_BYTES

See Also:

• Constant Field Values

FETCH_MAX_BYTES_CONFIG

public static final 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 String FETCH_MAX_WAIT_MS_CONFIG

fetch.max.wait.ms

See Also:

• Constant Field Values

DEFAULT_FETCH_MAX_WAIT_MS

public static final int DEFAULT_FETCH_MAX_WAIT_MS

See Also:

• Constant Field Values

METADATA_MAX_AGE_CONFIG

public static final String METADATA_MAX_AGE_CONFIG

metadata.max.age.ms

See Also:

• Constant Field Values

MAX_PARTITION_FETCH_BYTES_CONFIG

public static final 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 String SEND_BUFFER_CONFIG

send.buffer.bytes

See Also:

• Constant Field Values

RECEIVE_BUFFER_CONFIG

public static final String RECEIVE_BUFFER_CONFIG

receive.buffer.bytes

See Also:

• Constant Field Values

CLIENT_ID_CONFIG

public static final String CLIENT_ID_CONFIG

client.id

See Also:

• Constant Field Values

CLIENT_RACK_CONFIG

public static final String CLIENT_RACK_CONFIG

client.rack

See Also:

• Constant Field Values

DEFAULT_CLIENT_RACK

public static final String DEFAULT_CLIENT_RACK

See Also:

• Constant Field Values

RECONNECT_BACKOFF_MS_CONFIG

public static final String RECONNECT_BACKOFF_MS_CONFIG

reconnect.backoff.ms

See Also:

• Constant Field Values

RECONNECT_BACKOFF_MAX_MS_CONFIG

public static final String RECONNECT_BACKOFF_MAX_MS_CONFIG

reconnect.backoff.max.ms

See Also:

• Constant Field Values

RETRY_BACKOFF_MS_CONFIG

public static final String RETRY_BACKOFF_MS_CONFIG

retry.backoff.ms

See Also:

• Constant Field Values

ENABLE_METRICS_PUSH_CONFIG

public static final String ENABLE_METRICS_PUSH_CONFIG

enable.metrics.push

See Also:

• Constant Field Values

ENABLE_METRICS_PUSH_DOC

public static final String ENABLE_METRICS_PUSH_DOC

See Also:

• Constant Field Values

RETRY_BACKOFF_MAX_MS_CONFIG

public static final String RETRY_BACKOFF_MAX_MS_CONFIG

retry.backoff.max.ms

See Also:

• Constant Field Values

METRICS_SAMPLE_WINDOW_MS_CONFIG

public static final String METRICS_SAMPLE_WINDOW_MS_CONFIG

metrics.sample.window.ms

See Also:

• Constant Field Values

METRICS_NUM_SAMPLES_CONFIG

public static final String METRICS_NUM_SAMPLES_CONFIG

metrics.num.samples

See Also:

• Constant Field Values

METRICS_RECORDING_LEVEL_CONFIG

public static final String METRICS_RECORDING_LEVEL_CONFIG

metrics.log.level

See Also:

• Constant Field Values

METRIC_REPORTER_CLASSES_CONFIG

public static final String METRIC_REPORTER_CLASSES_CONFIG

metric.reporters

See Also:

• Constant Field Values

CHECK_CRCS_CONFIG

public static final String CHECK_CRCS_CONFIG

check.crcs

See Also:

• Constant Field Values

KEY_DESERIALIZER_CLASS_CONFIG

public static final String KEY_DESERIALIZER_CLASS_CONFIG

key.deserializer

See Also:

• Constant Field Values

KEY_DESERIALIZER_CLASS_DOC

public static final String KEY_DESERIALIZER_CLASS_DOC

See Also:

• Constant Field Values

VALUE_DESERIALIZER_CLASS_CONFIG

public static final String VALUE_DESERIALIZER_CLASS_CONFIG

value.deserializer

See Also:

• Constant Field Values

VALUE_DESERIALIZER_CLASS_DOC

public static final String VALUE_DESERIALIZER_CLASS_DOC

See Also:

• Constant Field Values

SOCKET_CONNECTION_SETUP_TIMEOUT_MS_CONFIG

public static final String SOCKET_CONNECTION_SETUP_TIMEOUT_MS_CONFIG

socket.connection.setup.timeout.ms

See Also:

• Constant Field Values

SOCKET_CONNECTION_SETUP_TIMEOUT_MAX_MS_CONFIG

public static final String SOCKET_CONNECTION_SETUP_TIMEOUT_MAX_MS_CONFIG

socket.connection.setup.timeout.max.ms

See Also:

• Constant Field Values

CONNECTIONS_MAX_IDLE_MS_CONFIG

public static final String CONNECTIONS_MAX_IDLE_MS_CONFIG

connections.max.idle.ms

See Also:

• Constant Field Values

REQUEST_TIMEOUT_MS_CONFIG

public static final String REQUEST_TIMEOUT_MS_CONFIG

request.timeout.ms

See Also:

• Constant Field Values

DEFAULT_API_TIMEOUT_MS_CONFIG

public static final String DEFAULT_API_TIMEOUT_MS_CONFIG

default.api.timeout.ms

See Also:

• Constant Field Values

INTERCEPTOR_CLASSES_CONFIG

public static final String INTERCEPTOR_CLASSES_CONFIG

interceptor.classes

See Also:

• Constant Field Values

INTERCEPTOR_CLASSES_DOC

public static final String INTERCEPTOR_CLASSES_DOC

See Also:

• Constant Field Values

EXCLUDE_INTERNAL_TOPICS_CONFIG

public static final 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 String ISOLATION_LEVEL_CONFIG

isolation.level

See Also:

• Constant Field Values

ISOLATION_LEVEL_DOC

public static final String ISOLATION_LEVEL_DOC

See Also:

• Constant Field Values

DEFAULT_ISOLATION_LEVEL

public static final String DEFAULT_ISOLATION_LEVEL

ALLOW_AUTO_CREATE_TOPICS_CONFIG

public static final String ALLOW_AUTO_CREATE_TOPICS_CONFIG

allow.auto.create.topics

See Also:

• Constant Field Values

DEFAULT_ALLOW_AUTO_CREATE_TOPICS

public static final boolean DEFAULT_ALLOW_AUTO_CREATE_TOPICS

See Also:

• Constant Field Values

SECURITY_PROVIDERS_CONFIG

public static final String SECURITY_PROVIDERS_CONFIG

security.providers

See Also:

• Constant Field Values

Constructor Details

ConsumerConfig

public ConsumerConfig(Properties props)

ConsumerConfig

public ConsumerConfig(Map<String,Object> props)

Method Details

appendDeserializerToConfig

public static Map<String,Object> appendDeserializerToConfig(Map<String,Object> configs,
 Deserializer<?> keyDeserializer,
 Deserializer<?> valueDeserializer)

configNames

public static Set<String> configNames()

configDef

public static ConfigDef configDef()

main

public static void main(String[] args)