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

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

CONFIG_PROVIDERS_CONFIG

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`ConsumerConfig(Map<?,?> props, boolean doLog)`
	`ConsumerConfig(Map<String,Object> props)`
	`ConsumerConfig(Properties props)`

Method Summary

Modifier and Type	Method	Description
`protected 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)`
`protected Map<String,Object>`	`postProcessParsedConfig(Map<String,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

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, finalize, 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
- 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
- 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
- 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
- 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
- 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
- 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)
- ConsumerConfig
  
  protected ConsumerConfig(Map<?,?> props, boolean doLog)
Method Details
- postProcessParsedConfig
  
  protected Map<String,Object> postProcessParsedConfig(Map<String,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)
- appendDeserializerToConfig
  
  protected 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)

Class ConsumerConfig

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Details

ASSIGN_FROM_SUBSCRIBED_ASSIGNORS

GROUP_ID_CONFIG

GROUP_INSTANCE_ID_CONFIG

MAX_POLL_RECORDS_CONFIG

MAX_POLL_INTERVAL_MS_CONFIG

SESSION_TIMEOUT_MS_CONFIG

HEARTBEAT_INTERVAL_MS_CONFIG

BOOTSTRAP_SERVERS_CONFIG

CLIENT_DNS_LOOKUP_CONFIG

ENABLE_AUTO_COMMIT_CONFIG

AUTO_COMMIT_INTERVAL_MS_CONFIG

PARTITION_ASSIGNMENT_STRATEGY_CONFIG

AUTO_OFFSET_RESET_CONFIG

AUTO_OFFSET_RESET_DOC

FETCH_MIN_BYTES_CONFIG

FETCH_MAX_BYTES_CONFIG

DEFAULT_FETCH_MAX_BYTES

FETCH_MAX_WAIT_MS_CONFIG

METADATA_MAX_AGE_CONFIG

MAX_PARTITION_FETCH_BYTES_CONFIG

DEFAULT_MAX_PARTITION_FETCH_BYTES

SEND_BUFFER_CONFIG

RECEIVE_BUFFER_CONFIG

CLIENT_ID_CONFIG

CLIENT_RACK_CONFIG

RECONNECT_BACKOFF_MS_CONFIG

RECONNECT_BACKOFF_MAX_MS_CONFIG

RETRY_BACKOFF_MS_CONFIG

METRICS_SAMPLE_WINDOW_MS_CONFIG

METRICS_NUM_SAMPLES_CONFIG

METRICS_RECORDING_LEVEL_CONFIG

METRIC_REPORTER_CLASSES_CONFIG

CHECK_CRCS_CONFIG

KEY_DESERIALIZER_CLASS_CONFIG

KEY_DESERIALIZER_CLASS_DOC

VALUE_DESERIALIZER_CLASS_CONFIG

VALUE_DESERIALIZER_CLASS_DOC

SOCKET_CONNECTION_SETUP_TIMEOUT_MS_CONFIG

SOCKET_CONNECTION_SETUP_TIMEOUT_MAX_MS_CONFIG

CONNECTIONS_MAX_IDLE_MS_CONFIG

REQUEST_TIMEOUT_MS_CONFIG

DEFAULT_API_TIMEOUT_MS_CONFIG

INTERCEPTOR_CLASSES_CONFIG

INTERCEPTOR_CLASSES_DOC

EXCLUDE_INTERNAL_TOPICS_CONFIG

DEFAULT_EXCLUDE_INTERNAL_TOPICS

ISOLATION_LEVEL_CONFIG

ISOLATION_LEVEL_DOC

DEFAULT_ISOLATION_LEVEL

ALLOW_AUTO_CREATE_TOPICS_CONFIG

DEFAULT_ALLOW_AUTO_CREATE_TOPICS

SECURITY_PROVIDERS_CONFIG

Constructor Details

ConsumerConfig

ConsumerConfig

ConsumerConfig

Method Details

postProcessParsedConfig

appendDeserializerToConfig

configNames

configDef

main