Package org.apache.kafka.clients.producer

Class ProducerConfig

java.lang.Object

org.apache.kafka.common.config.AbstractConfig

org.apache.kafka.clients.producer.ProducerConfig

public class ProducerConfig
extends AbstractConfig

Configuration for the Kafka Producer. Documentation for these configurations can be found in the Kafka documentation

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACKS_CONFIG	acks
static final String	BATCH_SIZE_CONFIG	batch.size
static final String	BOOTSTRAP_SERVERS_CONFIG	bootstrap.servers
static final String	BUFFER_MEMORY_CONFIG	buffer.memory
static final String	CLIENT_DNS_LOOKUP_CONFIG	client.dns.lookup
static final String	CLIENT_ID_CONFIG	client.id
static final String	COMPRESSION_GZIP_LEVEL_CONFIG	compression.gzip.level
static final String	COMPRESSION_LZ4_LEVEL_CONFIG	compression.lz4.level
static final String	COMPRESSION_TYPE_CONFIG	compression.type
static final String	COMPRESSION_ZSTD_LEVEL_CONFIG	compression.zstd.level
static final String	CONNECTIONS_MAX_IDLE_MS_CONFIG	connections.max.idle.ms
static final String	DELIVERY_TIMEOUT_MS_CONFIG	delivery.timeout.ms
static final String	ENABLE_IDEMPOTENCE_CONFIG	enable.idempotence
static final String	ENABLE_IDEMPOTENCE_DOC
static final String	ENABLE_METRICS_PUSH_CONFIG	enable.metrics.push
static final String	ENABLE_METRICS_PUSH_DOC
static final String	INTERCEPTOR_CLASSES_CONFIG	interceptor.classes
static final String	INTERCEPTOR_CLASSES_DOC
static final String	KEY_SERIALIZER_CLASS_CONFIG	key.serializer
static final String	KEY_SERIALIZER_CLASS_DOC
static final String	LINGER_MS_CONFIG	linger.ms
static final String	MAX_BLOCK_MS_CONFIG	max.block.ms
static final String	MAX_IN_FLIGHT_REQUESTS_PER_CONNECTION	max.in.flight.requests.per.connection
static final String	MAX_REQUEST_SIZE_CONFIG	max.request.size
static final String	METADATA_MAX_AGE_CONFIG	metadata.max.age.ms
static final String	METADATA_MAX_IDLE_CONFIG	metadata.max.idle.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.recording.level
static final String	METRICS_SAMPLE_WINDOW_MS_CONFIG	metrics.sample.window.ms
static final String	PARTITIONER_ADAPTIVE_PARTITIONING_ENABLE_CONFIG	partitioner.adaptive.partitioning.enable
static final String	PARTITIONER_ADPATIVE_PARTITIONING_ENABLE_CONFIG	Deprecated.
static final String	PARTITIONER_AVAILABILITY_TIMEOUT_MS_CONFIG	partitioner.availability.timeout.ms
static final String	PARTITIONER_CLASS_CONFIG	partitioner.class
static final String	PARTITIONER_IGNORE_KEYS_CONFIG	partitioner.ignore.keys
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	RETRIES_CONFIG	retries
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	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	TRANSACTION_TIMEOUT_CONFIG	transaction.timeout.ms
static final String	TRANSACTION_TIMEOUT_DOC
static final String	TRANSACTION_TWO_PHASE_COMMIT_ENABLE_CONFIG	transaction.two.phase.commit.enable
static final String	TRANSACTIONAL_ID_CONFIG	transactional.id
static final String	TRANSACTIONAL_ID_DOC
static final String	VALUE_SERIALIZER_CLASS_CONFIG	value.serializer
static final String	VALUE_SERIALIZER_CLASS_DOC

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

AUTOMATIC_CONFIG_PROVIDERS_PROPERTY, CONFIG_PROVIDERS_CONFIG, CONFIG_PROVIDERS_DOC

Constructor Summary

Constructors

Constructor	Description
ProducerConfig(Map<String,Object> props)	Constructs a new ProducerConfig with the given configuration map.
ProducerConfig(Properties props)	Constructs a new ProducerConfig with the given properties.

Method Summary

Modifier and Type	Method	Description
static ConfigDef	configDef()	Gets a copy of the producer configuration definition.
static Set<String>	configNames()	Gets the set of all producer configuration names.
static void	main(String[] args)	Generates HTML documentation for producer configurations.

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

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

METADATA_MAX_AGE_CONFIG

public static final String METADATA_MAX_AGE_CONFIG

metadata.max.age.ms

See Also:

• Constant Field Values

METADATA_MAX_IDLE_CONFIG

public static final String METADATA_MAX_IDLE_CONFIG

metadata.max.idle.ms

See Also:

• Constant Field Values

BATCH_SIZE_CONFIG

public static final String BATCH_SIZE_CONFIG

batch.size

See Also:

• Constant Field Values

PARTITIONER_ADAPTIVE_PARTITIONING_ENABLE_CONFIG

public static final String PARTITIONER_ADAPTIVE_PARTITIONING_ENABLE_CONFIG

partitioner.adaptive.partitioning.enable

See Also:

• Constant Field Values

PARTITIONER_ADPATIVE_PARTITIONING_ENABLE_CONFIG

@Deprecated
public static final String PARTITIONER_ADPATIVE_PARTITIONING_ENABLE_CONFIG

Deprecated.

See Also:

• Constant Field Values

PARTITIONER_AVAILABILITY_TIMEOUT_MS_CONFIG

public static final String PARTITIONER_AVAILABILITY_TIMEOUT_MS_CONFIG

partitioner.availability.timeout.ms

See Also:

• Constant Field Values

PARTITIONER_IGNORE_KEYS_CONFIG

public static final String PARTITIONER_IGNORE_KEYS_CONFIG

partitioner.ignore.keys

See Also:

• Constant Field Values

ACKS_CONFIG

public static final String ACKS_CONFIG

acks

See Also:

• Constant Field Values

LINGER_MS_CONFIG

public static final String LINGER_MS_CONFIG

linger.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

DELIVERY_TIMEOUT_MS_CONFIG

public static final String DELIVERY_TIMEOUT_MS_CONFIG

delivery.timeout.ms

See Also:

• Constant Field Values

CLIENT_ID_CONFIG

public static final String CLIENT_ID_CONFIG

client.id

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

MAX_REQUEST_SIZE_CONFIG

public static final String MAX_REQUEST_SIZE_CONFIG

max.request.size

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

MAX_BLOCK_MS_CONFIG

public static final String MAX_BLOCK_MS_CONFIG

max.block.ms

See Also:

• Constant Field Values

BUFFER_MEMORY_CONFIG

public static final String BUFFER_MEMORY_CONFIG

buffer.memory

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

RETRY_BACKOFF_MAX_MS_CONFIG

public static final String RETRY_BACKOFF_MAX_MS_CONFIG

retry.backoff.max.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

COMPRESSION_TYPE_CONFIG

public static final String COMPRESSION_TYPE_CONFIG

compression.type

See Also:

• Constant Field Values

COMPRESSION_GZIP_LEVEL_CONFIG

public static final String COMPRESSION_GZIP_LEVEL_CONFIG

compression.gzip.level

See Also:

• Constant Field Values

COMPRESSION_LZ4_LEVEL_CONFIG

public static final String COMPRESSION_LZ4_LEVEL_CONFIG

compression.lz4.level

See Also:

• Constant Field Values

COMPRESSION_ZSTD_LEVEL_CONFIG

public static final String COMPRESSION_ZSTD_LEVEL_CONFIG

compression.zstd.level

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.recording.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

MAX_IN_FLIGHT_REQUESTS_PER_CONNECTION

public static final String MAX_IN_FLIGHT_REQUESTS_PER_CONNECTION

max.in.flight.requests.per.connection

See Also:

• Constant Field Values

RETRIES_CONFIG

public static final String RETRIES_CONFIG

retries

See Also:

• Constant Field Values

KEY_SERIALIZER_CLASS_CONFIG

public static final String KEY_SERIALIZER_CLASS_CONFIG

key.serializer

See Also:

• Constant Field Values

KEY_SERIALIZER_CLASS_DOC

public static final String KEY_SERIALIZER_CLASS_DOC

See Also:

• Constant Field Values

VALUE_SERIALIZER_CLASS_CONFIG

public static final String VALUE_SERIALIZER_CLASS_CONFIG

value.serializer

See Also:

• Constant Field Values

VALUE_SERIALIZER_CLASS_DOC

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

PARTITIONER_CLASS_CONFIG

public static final String PARTITIONER_CLASS_CONFIG

partitioner.class

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

ENABLE_IDEMPOTENCE_CONFIG

public static final String ENABLE_IDEMPOTENCE_CONFIG

enable.idempotence

See Also:

• Constant Field Values

ENABLE_IDEMPOTENCE_DOC

public static final String ENABLE_IDEMPOTENCE_DOC

See Also:

• Constant Field Values

TRANSACTION_TIMEOUT_CONFIG

public static final String TRANSACTION_TIMEOUT_CONFIG

transaction.timeout.ms

See Also:

• Constant Field Values

TRANSACTION_TIMEOUT_DOC

public static final String TRANSACTION_TIMEOUT_DOC

See Also:

• Constant Field Values

TRANSACTIONAL_ID_CONFIG

public static final String TRANSACTIONAL_ID_CONFIG

transactional.id

See Also:

• Constant Field Values

TRANSACTIONAL_ID_DOC

public static final String TRANSACTIONAL_ID_DOC

See Also:

• Constant Field Values

TRANSACTION_TWO_PHASE_COMMIT_ENABLE_CONFIG

public static final String TRANSACTION_TWO_PHASE_COMMIT_ENABLE_CONFIG

transaction.two.phase.commit.enable

See Also:

• Constant Field Values

SECURITY_PROVIDERS_CONFIG

public static final String SECURITY_PROVIDERS_CONFIG

security.providers

See Also:

• Constant Field Values

Constructor Details

ProducerConfig

public ProducerConfig(Properties props)

Constructs a new ProducerConfig with the given properties.

Parameters:

props - The producer configuration properties

ProducerConfig

public ProducerConfig(Map<String,Object> props)

Constructs a new ProducerConfig with the given configuration map.

Parameters:

props - The producer configuration map

Method Details

configNames

public static Set<String> configNames()

Gets the set of all producer configuration names.

Returns:

The set of configuration names

configDef

public static ConfigDef configDef()

Gets a copy of the producer configuration definition.

Returns:

A new ConfigDef instance containing the producer configuration definition

main

public static void main(String[] args)

Generates HTML documentation for producer configurations.

Parameters:

args - Command line arguments (unused)