Properties
Optional api.version.fallback.ms
api.version.fallback.ms: undefined | number
Optional api.version.request
api.version.request: undefined | false | true
Optional api.version.request.timeout.ms
api.version.request.timeout.ms: undefined | number
Optional auto.commit.interval.ms
auto.commit.interval.ms: undefined | number
Optional background_event_cb
background_event_cb: Function
Optional bootstrap.servers
bootstrap.servers: undefined | string
Optional broker.address.family
broker.address.family: "any" | "v4" | "v6"
Optional broker.address.ttl
broker.address.ttl: undefined | number
Optional broker.version.fallback
broker.version.fallback: undefined | string
Optional builtin.features
builtin.features: unknown
Optional check.crcs
check.crcs: undefined | false | true
Optional client.id
client.id: undefined | string
Optional client.rack
client.rack: undefined | string
Optional closesocket_cb
closesocket_cb: Function
Optional connect_cb
connect_cb: Function
Optional consume_cb
consume_cb: Function
Optional coordinator.query.interval.ms
coordinator.query.interval.ms: undefined | number
Optional debug
debug: "generic" | "broker" | "topic" | "metadata" | "feature" | "queue" | "msg" | "protocol" | "cgrp" | "security" | "fetch" | "interceptor" | "plugin" | "consumer" | "admin" | "eos" | "mock" | "all"
Optional default_topic_conf
default_topic_conf: undefined | object
Optional enable.auto.commit
enable.auto.commit: undefined | false | true
Optional enable.auto.offset.store
enable.auto.offset.store: undefined | false | true
Optional enable.partition.eof
enable.partition.eof: undefined | false | true
Optional enable.sasl.oauthbearer.unsecure.jwt
enable.sasl.oauthbearer.unsecure.jwt: undefined | false | true
Optional enable.ssl.certificate.verification
enable.ssl.certificate.verification: undefined | false | true
Optional enabled_events
enabled_events: undefined | number
Optional error_cb
error_cb: Function
Optional fetch.error.backoff.ms
fetch.error.backoff.ms: undefined | number
Optional fetch.max.bytes
fetch.max.bytes: undefined | number
Optional fetch.message.max.bytes
fetch.message.max.bytes: undefined | number
Optional fetch.min.bytes
fetch.min.bytes: undefined | number
Optional fetch.wait.max.ms
fetch.wait.max.ms: undefined | number
Optional group.id
group.id: undefined | string
Optional group.protocol.type
group.protocol.type: undefined | string
Optional heartbeat.interval.ms
heartbeat.interval.ms: undefined | number
Optional internal.termination.signal
internal.termination.signal: undefined | number
Optional isolation.level
isolation.level: "read_uncommitted" | "read_committed"
Optional log.connection.close
log.connection.close: undefined | false | true
Optional log.queue
log.queue: undefined | false | true
Optional log.thread.name
log.thread.name: undefined | false | true
Optional log_cb
log_cb: Function
Optional log_level
log_level: undefined | number
Optional max.in.flight
max.in.flight: undefined | number
Optional max.in.flight.requests.per.connection
max.in.flight.requests.per.connection: undefined | number
Optional max.partition.fetch.bytes
max.partition.fetch.bytes: undefined | number
Optional max.poll.interval.ms
max.poll.interval.ms: undefined | number
Optional message.copy.max.bytes
message.copy.max.bytes: undefined | number
Optional message.max.bytes
message.max.bytes: undefined | number
Optional metadata.broker.list
metadata.broker.list: undefined | string
Optional metadata.max.age.ms
metadata.max.age.ms: undefined | number
Optional metadata.request.timeout.ms
metadata.request.timeout.ms: undefined | number
Optional oauthbearer_token_refresh_cb
oauthbearer_token_refresh_cb: Function
Optional offset.store.method
offset.store.method: "none" | "file" | "broker"
Optional offset_commit_cb
offset_commit_cb: Function
Optional opaque
opaque: unknown
Optional open_cb
open_cb: Function
Optional partition.assignment.strategy
partition.assignment.strategy: undefined | string
Optional plugin.library.paths
plugin.library.paths: undefined | string
Optional queued.max.messages.kbytes
queued.max.messages.kbytes: undefined | number
Optional queued.min.messages
queued.min.messages: undefined | number
Optional rebalance_cb
rebalance_cb: Function
Optional receive.message.max.bytes
receive.message.max.bytes: undefined | number
Optional reconnect.backoff.jitter.ms
reconnect.backoff.jitter.ms: undefined | number
Optional reconnect.backoff.max.ms
reconnect.backoff.max.ms: undefined | number
Optional reconnect.backoff.ms
reconnect.backoff.ms: undefined | number
Optional sasl.kerberos.keytab
sasl.kerberos.keytab: undefined | string
Optional sasl.kerberos.kinit.cmd
sasl.kerberos.kinit.cmd: undefined | string
Optional sasl.kerberos.min.time.before.relogin
sasl.kerberos.min.time.before.relogin: undefined | number
Optional sasl.kerberos.principal
sasl.kerberos.principal: undefined | string
Optional sasl.kerberos.service.name
sasl.kerberos.service.name: undefined | string
Optional sasl.mechanism
sasl.mechanism: undefined | string
Optional sasl.mechanisms
sasl.mechanisms: undefined | string
Optional sasl.oauthbearer.config
sasl.oauthbearer.config: undefined | string
Optional sasl.password
sasl.password: undefined | string
Optional sasl.username
sasl.username: undefined | string
Optional security.protocol
security.protocol: "plaintext" | "ssl" | "sasl_plaintext" | "sasl_ssl"
Optional session.timeout.ms
session.timeout.ms: undefined | number
Optional socket.blocking.max.ms
socket.blocking.max.ms: undefined | number
Optional socket.keepalive.enable
socket.keepalive.enable: undefined | false | true
Optional socket.max.fails
socket.max.fails: undefined | number
Optional socket.nagle.disable
socket.nagle.disable: undefined | false | true
Optional socket.receive.buffer.bytes
socket.receive.buffer.bytes: undefined | number
Optional socket.send.buffer.bytes
socket.send.buffer.bytes: undefined | number
Optional socket.timeout.ms
socket.timeout.ms: undefined | number
Optional socket_cb
socket_cb: Function
Optional ssl.ca.location
ssl.ca.location: undefined | string
Optional ssl.certificate.location
ssl.certificate.location: undefined | string
Optional ssl.certificate.pem
ssl.certificate.pem: undefined | string
Optional ssl.certificate.verify_cb
ssl.certificate.verify_cb: Function
Optional ssl.cipher.suites
ssl.cipher.suites: undefined | string
Optional ssl.crl.location
ssl.crl.location: undefined | string
Optional ssl.curves.list
ssl.curves.list: undefined | string
Optional ssl.endpoint.identification.algorithm
ssl.endpoint.identification.algorithm: "none" | "https"
Optional ssl.key.location
ssl.key.location: undefined | string
Optional ssl.key.password
ssl.key.password: undefined | string
Optional ssl.key.pem
ssl.key.pem: undefined | string
Optional ssl.keystore.location
ssl.keystore.location: undefined | string
Optional ssl.keystore.password
ssl.keystore.password: undefined | string
Optional ssl.sigalgs.list
ssl.sigalgs.list: undefined | string
Optional ssl_ca
ssl_ca: undefined | string
Optional ssl_certificate
ssl_certificate: undefined | string
Optional ssl_key
ssl_key: undefined | string
Optional statistics.interval.ms
statistics.interval.ms: undefined | number
Optional stats_cb
stats_cb: Function
Optional throttle_cb
throttle_cb: Function
Optional topic.blacklist
topic.blacklist: string[]
Optional topic.metadata.refresh.fast.cnt
topic.metadata.refresh.fast.cnt: undefined | number
Optional topic.metadata.refresh.fast.interval.ms
topic.metadata.refresh.fast.interval.ms: undefined | number
Optional topic.metadata.refresh.interval.ms
topic.metadata.refresh.interval.ms: undefined | number
Optional topic.metadata.refresh.sparse
topic.metadata.refresh.sparse: undefined | false | true