KafkaProducerConfig

The Kafka Producer config.

For the official documentation on the available configuration options, see Producer Configs on kafka.apache.org.

bootstrapServers: is the bootstrap.servers setting and represents the list of servers to connect to.
acks: is the acks setting and represents the number of acknowledgments the producer requires the leader to have received before considering a request complete. See Acks.
bufferMemoryInBytes: is the buffer.memory setting and represents the total bytes of memory the producer can use to buffer records waiting to be sent to the server.
compressionType: is the compression.type setting and specifies what compression algorithm to apply to all the generated data by the producer. The default is none (no compression applied).
retries: is the retries setting. A value greater than zero will cause the client to resend any record whose send fails with a potentially transient error.
batchSizeInBytes: is the batch.size setting. The producer will attempt to batch records together into fewer requests whenever multiple records are being sent to the same partition. This setting specifies the maximum number of records to batch together.
clientId: is the client.id setting, an id string to pass to the server when making requests. The purpose of this is to be able to track the source of requests beyond just ip/port by allowing a logical application name to be included in server-side request logging.
lingerTime: is the linger.ms setting and specifies to buffer records for more efficient batching, up to the maximum batch size or for the maximum lingerTime. If zero, then no buffering will happen, but if different from zero, then records will be delayed in absence of load.
maxRequestSizeInBytes: is the max.request.size setting and represents the maximum size of a request in bytes. This is also effectively a cap on the maximum record size.
receiveBufferInBytes: is the receive.buffer.bytes setting being the size of the TCP receive buffer (SO_RCVBUF) to use when reading data.
sendBufferInBytes: is the send.buffer.bytes setting, being the size of the TCP send buffer (SO_SNDBUF) to use when sending data.
timeout: is the timeout.ms setting, a configuration the controls the maximum amount of time the server will wait for acknowledgments from followers to meet the acknowledgment requirements the producer has specified with the acks configuration.
blockOnBufferFull: is the block.on.buffer.full setting, which controls whether producer stops accepting new records (blocks) or throws errors when the memory buffer is exhausted.
metadataFetchTimeout: is the metadata.fetch.timeout.ms setting. The period of time in milliseconds after which we force a refresh of metadata even if we haven't seen any partition leadership changes to proactively discover any new brokers or partitions.
metadataMaxAge: is the metadata.max.age.ms setting. The period of time in milliseconds after which we force a refresh of metadata even if we haven't seen any partition leadership changes to proactively discover any new brokers or partitions.
reconnectBackoffTime: is the reconnect.backoff.ms setting. The amount of time to wait before attempting to reconnect to a given host. This avoids repeatedly connecting to a host in a tight loop. This backoff applies to all requests sent by the consumer to the broker.
retryBackoffTime: is the retry.backoff.ms setting. The amount of time to wait before attempting to retry a failed request to a given topic partition. This avoids repeatedly sending requests in a tight loop under some failure scenarios.
monixSinkParallelism: is the monix.producer.sink.parallelism setting indicating how many requests the KafkaProducerSink can execute in parallel.

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new KafkaProducerConfig(bootstrapServers: List[String], acks: Acks, bufferMemoryInBytes: Int, compressionType: CompressionType, retries: Int, batchSizeInBytes: Int, clientId: String, lingerTime: FiniteDuration, maxRequestSizeInBytes: Int, receiveBufferInBytes: Int, sendBufferInBytes: Int, timeout: FiniteDuration, blockOnBufferFull: Boolean, metadataFetchTimeout: FiniteDuration, metadataMaxAge: FiniteDuration, reconnectBackoffTime: FiniteDuration, retryBackoffTime: FiniteDuration, monixSinkParallelism: Int)

bootstrapServers
is the bootstrap.servers setting and represents the list of servers to connect to.
acks
is the acks setting and represents the number of acknowledgments the producer requires the leader to have received before considering a request complete. See Acks.
bufferMemoryInBytes
is the buffer.memory setting and represents the total bytes of memory the producer can use to buffer records waiting to be sent to the server.
compressionType
is the compression.type setting and specifies what compression algorithm to apply to all the generated data by the producer. The default is none (no compression applied).
retries
is the retries setting. A value greater than zero will cause the client to resend any record whose send fails with a potentially transient error.
batchSizeInBytes
is the batch.size setting. The producer will attempt to batch records together into fewer requests whenever multiple records are being sent to the same partition. This setting specifies the maximum number of records to batch together.
clientId
is the client.id setting, an id string to pass to the server when making requests. The purpose of this is to be able to track the source of requests beyond just ip/port by allowing a logical application name to be included in server-side request logging.
lingerTime
is the linger.ms setting and specifies to buffer records for more efficient batching, up to the maximum batch size or for the maximum lingerTime. If zero, then no buffering will happen, but if different from zero, then records will be delayed in absence of load.
maxRequestSizeInBytes
is the max.request.size setting and represents the maximum size of a request in bytes. This is also effectively a cap on the maximum record size.
receiveBufferInBytes
is the receive.buffer.bytes setting being the size of the TCP receive buffer (SO_RCVBUF) to use when reading data.
sendBufferInBytes
is the send.buffer.bytes setting, being the size of the TCP send buffer (SO_SNDBUF) to use when sending data.
timeout
is the timeout.ms setting, a configuration the controls the maximum amount of time the server will wait for acknowledgments from followers to meet the acknowledgment requirements the producer has specified with the acks configuration.
blockOnBufferFull
is the block.on.buffer.full setting, which controls whether producer stops accepting new records (blocks) or throws errors when the memory buffer is exhausted.
metadataFetchTimeout
is the metadata.fetch.timeout.ms setting. The period of time in milliseconds after which we force a refresh of metadata even if we haven't seen any partition leadership changes to proactively discover any new brokers or partitions.
metadataMaxAge
is the metadata.max.age.ms setting. The period of time in milliseconds after which we force a refresh of metadata even if we haven't seen any partition leadership changes to proactively discover any new brokers or partitions.
reconnectBackoffTime
is the reconnect.backoff.ms setting. The amount of time to wait before attempting to reconnect to a given host. This avoids repeatedly connecting to a host in a tight loop. This backoff applies to all requests sent by the consumer to the broker.
retryBackoffTime
is the retry.backoff.ms setting. The amount of time to wait before attempting to retry a failed request to a given topic partition. This avoids repeatedly sending requests in a tight loop under some failure scenarios.
monixSinkParallelism
is the monix.producer.sink.parallelism setting indicating how many requests the KafkaProducerSink can execute in parallel.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val acks: Acks

is the acks setting and represents the number of acknowledgments the producer requires the leader to have received before considering a request complete.
is the acks setting and represents the number of acknowledgments the producer requires the leader to have received before considering a request complete. See Acks.
final def asInstanceOf[T0]: T0

Definition Classes
Any
val batchSizeInBytes: Int

is the batch.size setting.
is the batch.size setting. The producer will attempt to batch records together into fewer requests whenever multiple records are being sent to the same partition. This setting specifies the maximum number of records to batch together.
val blockOnBufferFull: Boolean

is the block.on.buffer.full setting, which controls whether producer stops accepting new records (blocks) or throws errors when the memory buffer is exhausted.
val bootstrapServers: List[String]

is the bootstrap.servers setting and represents the list of servers to connect to.
val bufferMemoryInBytes: Int

is the buffer.memory setting and represents the total bytes of memory the producer can use to buffer records waiting to be sent to the server.
val clientId: String

is the client.id setting, an id string to pass to the server when making requests.
is the client.id setting, an id string to pass to the server when making requests. The purpose of this is to be able to track the source of requests beyond just ip/port by allowing a logical application name to be included in server-side request logging.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val compressionType: CompressionType

is the compression.type setting and specifies what compression algorithm to apply to all the generated data by the producer.
is the compression.type setting and specifies what compression algorithm to apply to all the generated data by the producer. The default is none (no compression applied).
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val lingerTime: FiniteDuration

is the linger.ms setting and specifies to buffer records for more efficient batching, up to the maximum batch size or for the maximum lingerTime.
is the linger.ms setting and specifies to buffer records for more efficient batching, up to the maximum batch size or for the maximum lingerTime. If zero, then no buffering will happen, but if different from zero, then records will be delayed in absence of load.
val maxRequestSizeInBytes: Int

is the max.request.size setting and represents the maximum size of a request in bytes.
is the max.request.size setting and represents the maximum size of a request in bytes. This is also effectively a cap on the maximum record size.
val metadataFetchTimeout: FiniteDuration

is the metadata.fetch.timeout.ms setting.
is the metadata.fetch.timeout.ms setting. The period of time in milliseconds after which we force a refresh of metadata even if we haven't seen any partition leadership changes to proactively discover any new brokers or partitions.
val metadataMaxAge: FiniteDuration

is the metadata.max.age.ms setting.
is the metadata.max.age.ms setting. The period of time in milliseconds after which we force a refresh of metadata even if we haven't seen any partition leadership changes to proactively discover any new brokers or partitions.
val monixSinkParallelism: Int

is the monix.producer.sink.parallelism setting indicating how many requests the KafkaProducerSink can execute in parallel.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val receiveBufferInBytes: Int

is the receive.buffer.bytes setting being the size of the TCP receive buffer (SO_RCVBUF) to use when reading data.
val reconnectBackoffTime: FiniteDuration

is the reconnect.backoff.ms setting.
is the reconnect.backoff.ms setting. The amount of time to wait before attempting to reconnect to a given host. This avoids repeatedly connecting to a host in a tight loop. This backoff applies to all requests sent by the consumer to the broker.
val retries: Int

is the retries setting.
is the retries setting. A value greater than zero will cause the client to resend any record whose send fails with a potentially transient error.
val retryBackoffTime: FiniteDuration

is the retry.backoff.ms setting.
is the retry.backoff.ms setting. The amount of time to wait before attempting to retry a failed request to a given topic partition. This avoids repeatedly sending requests in a tight loop under some failure scenarios.
val sendBufferInBytes: Int

is the send.buffer.bytes setting, being the size of the TCP send buffer (SO_SNDBUF) to use when sending data.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val timeout: FiniteDuration

is the timeout.ms setting, a configuration the controls the maximum amount of time the server will wait for acknowledgments from followers to meet the acknowledgment requirements the producer has specified with the acks configuration.
def toMap: Map[String, String]
def toProperties: Properties
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object KafkaProducerConfig | package kafka

Instance Constructors

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val acks: Acks

final def asInstanceOf[T0]: T0

val batchSizeInBytes: Int

val blockOnBufferFull: Boolean

val bootstrapServers: List[String]

val bufferMemoryInBytes: Int

val clientId: String

def clone(): AnyRef

val compressionType: CompressionType

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

val lingerTime: FiniteDuration

val maxRequestSizeInBytes: Int

val metadataFetchTimeout: FiniteDuration

val metadataMaxAge: FiniteDuration

val monixSinkParallelism: Int

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val receiveBufferInBytes: Int

val reconnectBackoffTime: FiniteDuration

val retries: Int

val retryBackoffTime: FiniteDuration

val sendBufferInBytes: Int

final def synchronized[T0](arg0: ⇒ T0): T0

val timeout: FiniteDuration

def toMap: Map[String, String]

def toProperties: Properties

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped