Class ConfluentClientConfigProxy

Wraps the Confluent.Kafka.ClientConfig.

Inheritance

object

ConfluentClientConfigProxy

ConfluentConsumerConfigProxy

ConfluentProducerConfigProxy

KafkaClientConfig

Implements

IValidatableEndpointSettings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Silverback.Messaging.Configuration.Kafka

Assembly: Silverback.Integration.Kafka.dll

Syntax

public abstract class ConfluentClientConfigProxy : IValidatableEndpointSettings

Constructors

ConfluentClientConfigProxy(ClientConfig)

Initializes a new instance of the ConfluentClientConfigProxy class.

Declaration

protected ConfluentClientConfigProxy(ClientConfig confluentConfig)

Parameters

Type	Name	Description
ClientConfig	confluentConfig	The Confluent.Kafka.ClientConfig to wrap.

Properties

Acks

This field indicates the number of acknowledgements the leader broker must receive from ISR brokers before responding to the request: Zero=Broker does not send any response/ack to client, One=The leader will write the record to its local log but will respond without awaiting full acknowledgement from all followers. All=Broker will block until message is committed by all in sync replicas (ISRs). If there are less than min.insync.replicas (broker configuration) in the ISR set the produce request will fail.

Declaration

public Acks? Acks { get; set; }

Property Value

Type	Description
Acks?

AllowAutoCreateTopics

Allow automatic topic creation on the broker when subscribing to or assigning non-existent topics. The broker must also be configured with auto.create.topics.enable=true for this configuration to take effect. Note: the default value (true) for the producer is different from the default value (false) for the consumer. Further, the consumer default value is different from the Java consumer (true), and this property is not supported by the Java producer. Requires broker version >= 0.11.0.0, for older broker versions only the broker configuration applies.

default: false
importance: low

Declaration

public bool? AllowAutoCreateTopics { get; set; }

Property Value

Type	Description
bool?

ApiVersionFallbackMs

Dictates how long the broker.version.fallback fallback is used in the case the ApiVersionRequest fails. NOTE: The ApiVersionRequest is only issued when a new connection to the broker is made (such as after an upgrade).

default: 0
importance: medium

Declaration

public int? ApiVersionFallbackMs { get; set; }

Property Value

Type	Description
int?

ApiVersionRequest

Request broker's supported API versions to adjust functionality to available protocol features. If set to false, or the ApiVersionRequest fails, the fallback version broker.version.fallback will be used. NOTE: Depends on broker version >=0.10.0. If the request is not supported by (an older) broker the broker.version.fallback fallback is used.

default: true
importance: high

Declaration

public bool? ApiVersionRequest { get; set; }

Property Value

Type	Description
bool?

ApiVersionRequestTimeoutMs

Timeout for broker API version requests.

default: 10000
importance: low

Declaration

public int? ApiVersionRequestTimeoutMs { get; set; }

Property Value

Type	Description
int?

BootstrapServers

Initial list of brokers as a CSV list of broker host or host:port. The application may also use rd_kafka_brokers_add() to add brokers during runtime.

default: ''
importance: high

Declaration

public string BootstrapServers { get; set; }

Property Value

Type	Description
string

BrokerAddressFamily

Allowed broker IP address families: any, v4, v6

default: any
importance: low

Declaration

public BrokerAddressFamily? BrokerAddressFamily { get; set; }

Property Value

Type	Description
BrokerAddressFamily?

BrokerAddressTtl

How long to cache the broker address resolving results (milliseconds).

default: 1000
importance: low

Declaration

public int? BrokerAddressTtl { get; set; }

Property Value

Type	Description
int?

BrokerVersionFallback

Older broker versions (before 0.10.0) provide no way for a client to query for supported protocol features (ApiVersionRequest, see api.version.request) making it impossible for the client to know what features it may use. As a workaround a user may set this property to the expected broker version and the client will automatically adjust its feature set accordingly if the ApiVersionRequest fails (or is disabled). The fallback broker version will be used for api.version.fallback.ms. Valid values are: 0.9.0, 0.8.2, 0.8.1, 0.8.0. Any other value >= 0.10, such as 0.10.2.1, enables ApiVersionRequests.

default: 0.10.0
importance: medium

Declaration

public string BrokerVersionFallback { get; set; }

Property Value

Type	Description
string

CancellationDelayMaxMs

The maximum length of time (in milliseconds) before a cancellation request is acted on. Low values may result in measurably higher CPU usage.

default: 100 range: 1 <= dotnet.cancellation.delay.max.ms <= 10000
importance: low

Declaration

public int CancellationDelayMaxMs { set; }

Property Value

Type	Description
int

ClientDnsLookup

Controls how the client uses DNS lookups. By default, when the lookup returns multiple IP addresses for a hostname, they will all be attempted for connection before the connection is considered failed. This applies to both bootstrap and advertised servers. If the value is set to resolve_canonical_bootstrap_servers_only, each entry will be resolved and expanded into a list of canonical names. NOTE: Default here is different from the Java client's default behavior, which connects only to the first IP address returned for a hostname.

default: use_all_dns_ips
importance: low

Declaration

public ClientDnsLookup? ClientDnsLookup { get; set; }

Property Value

Type	Description
ClientDnsLookup?

ClientId

Client identifier.

default: rdkafka
importance: low

Declaration

public string ClientId { get; set; }

Property Value

Type	Description
string

ClientRack

A rack identifier for this client. This can be any string value which indicates where this client is physically located. It corresponds with the broker config broker.rack.

default: ''
importance: low

Declaration

public string ClientRack { get; set; }

Property Value

Type	Description
string

ConfluentConfig

Gets the Confluent.Kafka.ClientConfig instance being wrapped.

Declaration

protected ClientConfig ConfluentConfig { get; }

Property Value

Type	Description
ClientConfig

ConnectionsMaxIdleMs

Close broker connections after the specified time of inactivity. Disable with 0. If this property is left at its default value some heuristics are performed to determine a suitable default value, this is currently limited to identifying brokers on Azure (see librdkafka issue #3109 for more info).

default: 0
importance: medium

Declaration

public int? ConnectionsMaxIdleMs { get; set; }

Property Value

Type	Description
int?

Debug

A comma-separated list of debug contexts to enable. Detailed Producer debugging: broker,topic,msg. Consumer: consumer,cgrp,topic,fetch

default: ''
importance: medium

Declaration

public string Debug { get; set; }

Property Value

Type	Description
string

EnableRandomSeed

If enabled librdkafka will initialize the PRNG with srand(current_time.milliseconds) on the first invocation of rd_kafka_new() (required only if rand_r() is not available on your platform). If disabled the application must call srand() prior to calling rd_kafka_new().

default: true
importance: low

Declaration

public bool? EnableRandomSeed { get; set; }

Property Value

Type	Description
bool?

EnableSaslOauthbearerUnsecureJwt

Enable the builtin unsecure JWT OAUTHBEARER token handler if no oauthbearer_refresh_cb has been set. This builtin handler should only be used for development or testing, and not in production.

default: false
importance: low

Declaration

public bool? EnableSaslOauthbearerUnsecureJwt { get; set; }

Property Value

Type	Description
bool?

EnableSslCertificateVerification

Enable OpenSSL's builtin broker (server) certificate verification. This verification can be extended by the application by implementing a certificate_verify_cb.

default: true
importance: low

Declaration

public bool? EnableSslCertificateVerification { get; set; }

Property Value

Type	Description
bool?

InternalTerminationSignal

Signal that librdkafka will use to quickly terminate on rd_kafka_destroy(). If this signal is not set then there will be a delay before rd_kafka_wait_destroyed() returns true as internal threads are timing out their system calls. If this signal is set however the delay will be minimal. The application should mask this signal as an internal signal handler is installed.

default: 0
importance: low

Declaration

public int? InternalTerminationSignal { get; set; }

Property Value

Type	Description
int?

LogConnectionClose

Log broker disconnects. It might be useful to turn this off when interacting with 0.9 brokers with an aggressive connections.max.idle.ms value.

default: true
importance: low

Declaration

public bool? LogConnectionClose { get; set; }

Property Value

Type	Description
bool?

LogQueue

Disable spontaneous log_cb from internal librdkafka threads, instead enqueue log messages on queue set with rd_kafka_set_log_queue() and serve log callbacks or events through the standard poll APIs. NOTE: Log messages will linger in a temporary queue until the log queue has been set.

default: false
importance: low

Declaration

public bool? LogQueue { get; set; }

Property Value

Type	Description
bool?

LogThreadName

Print internal thread name in log messages (useful for debugging librdkafka internals)

default: true
importance: low

Declaration

public bool? LogThreadName { get; set; }

Property Value

Type	Description
bool?

MaxInFlight

Maximum number of in-flight requests per broker connection. This is a generic property applied to all broker communication, however it is primarily relevant to produce requests. In particular, note that other mechanisms limit the number of outstanding consumer fetch request per broker to one.

default: 1000000
importance: low

Declaration

public int? MaxInFlight { get; set; }

Property Value

Type	Description
int?

MessageCopyMaxBytes

Maximum size for message to be copied to buffer. Messages larger than this will be passed by reference (zero-copy) at the expense of larger iovecs.

default: 65535
importance: low

Declaration

public int? MessageCopyMaxBytes { get; set; }

Property Value

Type	Description
int?

MessageMaxBytes

Maximum Kafka protocol request message size. Due to differing framing overhead between protocol versions the producer is unable to reliably enforce a strict max message limit at produce time and may exceed the maximum size by one message in protocol ProduceRequests, the broker will enforce the the topic's max.message.bytes limit (see Apache Kafka documentation).

default: 1000000
importance: medium

Declaration

public int? MessageMaxBytes { get; set; }

Property Value

Type	Description
int?

MetadataMaxAgeMs

Metadata cache max age. Defaults to topic.metadata.refresh.interval.ms * 3

default: 900000
importance: low

Declaration

public int? MetadataMaxAgeMs { get; set; }

Property Value

Type	Description
int?

PluginLibraryPaths

List of plugin libraries to load (; separated). The library search path is platform dependent (see dlopen(3) for Unix and LoadLibrary() for Windows). If no filename extension is specified the platform-specific extension (such as .dll or .so) will be appended automatically.

default: ''
importance: low

Declaration

public string PluginLibraryPaths { get; set; }

Property Value

Type	Description
string

ReceiveMessageMaxBytes

Maximum Kafka protocol response message size. This serves as a safety precaution to avoid memory exhaustion in case of protocol hickups. This value must be at least fetch.max.bytes + 512 to allow for protocol overhead; the value is adjusted automatically unless the configuration property is explicitly set.

default: 100000000
importance: medium

Declaration

public int? ReceiveMessageMaxBytes { get; set; }

Property Value

Type	Description
int?

ReconnectBackoffMaxMs

The maximum time to wait before reconnecting to a broker after the connection has been closed.

default: 10000
importance: medium

Declaration

public int? ReconnectBackoffMaxMs { get; set; }

Property Value

Type	Description
int?

ReconnectBackoffMs

The initial time to wait before reconnecting to a broker after the connection has been closed. The time is increased exponentially until reconnect.backoff.max.ms is reached. -25% to +50% jitter is applied to each reconnect backoff. A value of 0 disables the backoff and reconnects immediately.

default: 100
importance: medium

Declaration

public int? ReconnectBackoffMs { get; set; }

Property Value

Type	Description
int?

SaslKerberosKeytab

Path to Kerberos keytab file. This configuration property is only used as a variable in sasl.kerberos.kinit.cmd as ... -t "%{sasl.kerberos.keytab}".

default: ''
importance: low

Declaration

public string SaslKerberosKeytab { get; set; }

Property Value

Type	Description
string

SaslKerberosKinitCmd

Shell command to refresh or acquire the client's Kerberos ticket. This command is executed on client creation and every sasl.kerberos.min.time.before.relogin (0=disable). %{config.prop.name} is replaced by corresponding config object value.

default: kinit -R -t "%{sasl.kerberos.keytab}" -k %{sasl.kerberos.principal} || kinit -t "%{sasl.kerberos.keytab}" -k %{sasl.kerberos.principal}
importance: low

Declaration

public string SaslKerberosKinitCmd { get; set; }

Property Value

Type	Description
string

SaslKerberosMinTimeBeforeRelogin

Minimum time in milliseconds between key refresh attempts. Disable automatic key refresh by setting this property to 0.

default: 60000
importance: low

Declaration

public int? SaslKerberosMinTimeBeforeRelogin { get; set; }

Property Value

Type	Description
int?

SaslKerberosPrincipal

This client's Kerberos principal name. (Not supported on Windows, will use the logon user's principal).

default: kafkaclient
importance: low

Declaration

public string SaslKerberosPrincipal { get; set; }

Property Value

Type	Description
string

SaslKerberosServiceName

Kerberos principal name that Kafka runs as, not including /hostname@REALM

default: kafka
importance: low

Declaration

public string SaslKerberosServiceName { get; set; }

Property Value

Type	Description
string

SaslMechanism

SASL mechanism to use for authentication. Supported: GSSAPI, PLAIN, SCRAM-SHA-256, SCRAM-SHA-512. NOTE: Despite the name, you may not configure more than one mechanism.

Declaration

public SaslMechanism? SaslMechanism { get; set; }

Property Value

Type	Description
SaslMechanism?

SaslOauthbearerClientId

Public identifier for the application. Must be unique across all clients that the authorization server handles. Only used when sasl.oauthbearer.method is set to "oidc".

default: ''
importance: low

Declaration

public string SaslOauthbearerClientId { get; set; }

Property Value

Type	Description
string

SaslOauthbearerClientSecret

Client secret only known to the application and the authorization server. This should be a sufficiently random string that is not guessable. Only used when sasl.oauthbearer.method is set to "oidc".

default: ''
importance: low

Declaration

public string SaslOauthbearerClientSecret { get; set; }

Property Value

Type	Description
string

SaslOauthbearerConfig

SASL/OAUTHBEARER configuration. The format is implementation-dependent and must be parsed accordingly. The default unsecured token implementation (see https://tools.ietf.org/html/rfc7515#appendix-A.5) recognizes space-separated name=value pairs with valid names including principalClaimName, principal, scopeClaimName, scope, and lifeSeconds. The default value for principalClaimName is "sub", the default value for scopeClaimName is "scope", and the default value for lifeSeconds is 3600. The scope value is CSV format with the default value being no/empty scope. For example: principalClaimName=azp principal=admin scopeClaimName=roles scope=role1,role2 lifeSeconds=600. In addition, SASL extensions can be communicated to the broker via extension_NAME=value. For example: principal=admin extension_traceId=123

default: ''
importance: low

Declaration

public string SaslOauthbearerConfig { get; set; }

Property Value

Type	Description
string

SaslOauthbearerExtensions

Allow additional information to be provided to the broker. Comma-separated list of key=value pairs. E.g., "supportFeatureX=true,organizationId=sales-emea".Only used when sasl.oauthbearer.method is set to "oidc".

default: ''
importance: low

Declaration

public string SaslOauthbearerExtensions { get; set; }

Property Value

Type	Description
string

SaslOauthbearerMethod

Set to "default" or "oidc" to control which login method to be used. If set to "oidc", the following properties must also be be specified: sasl.oauthbearer.client.id, sasl.oauthbearer.client.secret, and sasl.oauthbearer.token.endpoint.url.

default: default
importance: low

Declaration

public SaslOauthbearerMethod? SaslOauthbearerMethod { get; set; }

Property Value

Type	Description
SaslOauthbearerMethod?

SaslOauthbearerScope

Client use this to specify the scope of the access request to the broker. Only used when sasl.oauthbearer.method is set to "oidc".

default: ''
importance: low

Declaration

public string SaslOauthbearerScope { get; set; }

Property Value

Type	Description
string

SaslOauthbearerTokenEndpointUrl

OAuth/OIDC issuer token endpoint HTTP(S) URI used to retrieve token. Only used when sasl.oauthbearer.method is set to "oidc".

default: ''
importance: low

Declaration

public string SaslOauthbearerTokenEndpointUrl { get; set; }

Property Value

Type	Description
string

SaslPassword

SASL password for use with the PLAIN and SASL-SCRAM-.. mechanism

default: ''
importance: high

Declaration

public string SaslPassword { get; set; }

Property Value

Type	Description
string

SaslUsername

SASL username for use with the PLAIN and SASL-SCRAM-.. mechanisms

default: ''
importance: high

Declaration

public string SaslUsername { get; set; }

Property Value

Type	Description
string

SecurityProtocol

Protocol used to communicate with brokers.

default: plaintext
importance: high

Declaration

public SecurityProtocol? SecurityProtocol { get; set; }

Property Value

Type	Description
SecurityProtocol?

SocketConnectionSetupTimeoutMs

Maximum time allowed for broker connection setup (TCP connection setup as well SSL and SASL handshake). If the connection to the broker is not fully functional after this the connection will be closed and retried.

default: 30000
importance: medium

Declaration

public int? SocketConnectionSetupTimeoutMs { get; set; }

Property Value

Type	Description
int?

SocketKeepaliveEnable

Enable TCP keep-alives (SO_KEEPALIVE) on broker sockets

default: false
importance: low

Declaration

public bool? SocketKeepaliveEnable { get; set; }

Property Value

Type	Description
bool?

SocketMaxFails

Disconnect from broker when this number of send failures (e.g., timed out requests) is reached. Disable with 0. WARNING: It is highly recommended to leave this setting at its default value of 1 to avoid the client and broker to become desynchronized in case of request timeouts. NOTE: The connection is automatically re-established.

default: 1
importance: low

Declaration

public int? SocketMaxFails { get; set; }

Property Value

Type	Description
int?

SocketNagleDisable

Disable the Nagle algorithm (TCP_NODELAY) on broker sockets.

default: false
importance: low

Declaration

public bool? SocketNagleDisable { get; set; }

Property Value

Type	Description
bool?

SocketReceiveBufferBytes

Broker socket receive buffer size. System default is used if 0.

default: 0
importance: low

Declaration

public int? SocketReceiveBufferBytes { get; set; }

Property Value

Type	Description
int?

SocketSendBufferBytes

Broker socket send buffer size. System default is used if 0.

default: 0
importance: low

Declaration

public int? SocketSendBufferBytes { get; set; }

Property Value

Type	Description
int?

SocketTimeoutMs

Default timeout for network requests. Producer: ProduceRequests will use the lesser value of socket.timeout.ms and remaining message.timeout.ms for the first message in the batch. Consumer: FetchRequests will use fetch.wait.max.ms + socket.timeout.ms. Admin: Admin requests will use socket.timeout.ms or explicitly set rd_kafka_AdminOptions_set_operation_timeout() value.

default: 60000
importance: low

Declaration

public int? SocketTimeoutMs { get; set; }

Property Value

Type	Description
int?

SslCaCertificateStores

Comma-separated list of Windows Certificate stores to load CA certificates from. Certificates will be loaded in the same order as stores are specified. If no certificates can be loaded from any of the specified stores an error is logged and the OpenSSL library's default CA location is used instead. Store names are typically one or more of: MY, Root, Trust, CA.

default: Root
importance: low

Declaration

public string SslCaCertificateStores { get; set; }

Property Value

Type	Description
string

SslCaLocation

File or directory path to CA certificate(s) for verifying the broker's key. Defaults: On Windows the system's CA certificates are automatically looked up in the Windows Root certificate store. On Mac OSX this configuration defaults to probe. It is recommended to install openssl using Homebrew, to provide CA certificates. On Linux install the distribution's ca-certificates package. If OpenSSL is statically linked or ssl.ca.location is set to probe a list of standard paths will be probed and the first one found will be used as the default CA certificate location path. If OpenSSL is dynamically linked the OpenSSL library's default path will be used (see OPENSSLDIR in openssl version -a).

default: ''
importance: low

Declaration

public string SslCaLocation { get; set; }

Property Value

Type	Description
string

SslCaPem

CA certificate string (PEM format) for verifying the broker's key.

default: ''
importance: low

Declaration

public string SslCaPem { get; set; }

Property Value

Type	Description
string

SslCertificateLocation

Path to client's public key (PEM) used for authentication.

default: ''
importance: low

Declaration

public string SslCertificateLocation { get; set; }

Property Value

Type	Description
string

SslCertificatePem

Client's public key string (PEM format) used for authentication.

default: ''
importance: low

Declaration

public string SslCertificatePem { get; set; }

Property Value

Type	Description
string

SslCipherSuites

A cipher suite is a named combination of authentication, encryption, MAC and key exchange algorithm used to negotiate the security settings for a network connection using TLS or SSL network protocol. See manual page for ciphers(1) and `SSL_CTX_set_cipher_list(3).

default: ''
importance: low

Declaration

public string SslCipherSuites { get; set; }

Property Value

Type	Description
string

SslCrlLocation

Path to CRL for verifying broker's certificate validity.

default: ''
importance: low

Declaration

public string SslCrlLocation { get; set; }

Property Value

Type	Description
string

SslCurvesList

The supported-curves extension in the TLS ClientHello message specifies the curves (standard/named, or 'explicit' GF(2^k) or GF(p)) the client is willing to have the server use. See manual page for SSL_CTX_set1_curves_list(3). OpenSSL >= 1.0.2 required.

default: ''
importance: low

Declaration

public string SslCurvesList { get; set; }

Property Value

Type	Description
string

SslEndpointIdentificationAlgorithm

Endpoint identification algorithm to validate broker hostname using broker certificate. https - Server (broker) hostname verification as specified in RFC2818. none - No endpoint verification. OpenSSL >= 1.0.2 required.

default: https
importance: low

Declaration

public SslEndpointIdentificationAlgorithm? SslEndpointIdentificationAlgorithm { get; set; }

Property Value

Type	Description
SslEndpointIdentificationAlgorithm?

SslEngineId

OpenSSL engine id is the name used for loading engine.

default: dynamic
importance: low

Declaration

public string SslEngineId { get; set; }

Property Value

Type	Description
string

SslEngineLocation

DEPRECATED Path to OpenSSL engine library. OpenSSL >= 1.1.x required. DEPRECATED: OpenSSL engine support is deprecated and should be replaced by OpenSSL 3 providers.

default: ''
importance: low

Declaration

public string SslEngineLocation { get; set; }

Property Value

Type	Description
string

SslKeyLocation

Path to client's private key (PEM) used for authentication.

default: ''
importance: low

Declaration

public string SslKeyLocation { get; set; }

Property Value

Type	Description
string

SslKeyPassword

Private key passphrase (for use with ssl.key.location and set_ssl_cert())

default: ''
importance: low

Declaration

public string SslKeyPassword { get; set; }

Property Value

Type	Description
string

SslKeyPem

Client's private key string (PEM format) used for authentication.

default: ''
importance: low

Declaration

public string SslKeyPem { get; set; }

Property Value

Type	Description
string

SslKeystoreLocation

Path to client's keystore (PKCS#12) used for authentication.

default: ''
importance: low

Declaration

public string SslKeystoreLocation { get; set; }

Property Value

Type	Description
string

SslKeystorePassword

Client's keystore (PKCS#12) password.

default: ''
importance: low

Declaration

public string SslKeystorePassword { get; set; }

Property Value

Type	Description
string

SslProviders

Comma-separated list of OpenSSL 3.0.x implementation providers. E.g., "default,legacy".

default: ''
importance: low

Declaration

public string SslProviders { get; set; }

Property Value

Type	Description
string

SslSigalgsList

The client uses the TLS ClientHello signature_algorithms extension to indicate to the server which signature/hash algorithm pairs may be used in digital signatures. See manual page for SSL_CTX_set1_sigalgs_list(3). OpenSSL >= 1.0.2 required.

default: ''
importance: low

Declaration

public string SslSigalgsList { get; set; }

Property Value

Type	Description
string

StatisticsIntervalMs

librdkafka statistics emit interval. The application also needs to register a stats callback using rd_kafka_conf_set_stats_cb(). The granularity is 1000ms. A value of 0 disables statistics.

default: 0
importance: high

Declaration

public int? StatisticsIntervalMs { get; set; }

Property Value

Type	Description
int?

TopicBlacklist

Topic blacklist, a comma-separated list of regular expressions for matching topic names that should be ignored in broker metadata information as if the topics did not exist.

default: ''
importance: low

Declaration

public string TopicBlacklist { get; set; }

Property Value

Type	Description
string

TopicMetadataPropagationMaxMs

Apache Kafka topic creation is asynchronous and it takes some time for a new topic to propagate throughout the cluster to all brokers. If a client requests topic metadata after manual topic creation but before the topic has been fully propagated to the broker the client is requesting metadata from, the topic will seem to be non-existent and the client will mark the topic as such, failing queued produced messages with ERR__UNKNOWN_TOPIC. This setting delays marking a topic as non-existent until the configured propagation max time has passed. The maximum propagation time is calculated from the time the topic is first referenced in the client, e.g., on produce().

default: 30000
importance: low

Declaration

public int? TopicMetadataPropagationMaxMs { get; set; }

Property Value

Type	Description
int?

TopicMetadataRefreshFastIntervalMs

When a topic loses its leader a new metadata request will be enqueued immediately and then with this initial interval, exponentially increasing upto retry.backoff.max.ms, until the topic metadata has been refreshed. If not set explicitly, it will be defaulted to retry.backoff.ms. This is used to recover quickly from transitioning leader brokers.

default: 100
importance: low

Declaration

public int? TopicMetadataRefreshFastIntervalMs { get; set; }

Property Value

Type	Description
int?

TopicMetadataRefreshIntervalMs

Period of time in milliseconds at which topic and broker metadata is refreshed in order to proactively discover any new brokers, topics, partitions or partition leader changes. Use -1 to disable the intervalled refresh (not recommended). If there are no locally referenced topics (no topic objects created, no messages produced, no subscription or no assignment) then only the broker list will be refreshed every interval but no more often than every 10s.

default: 300000
importance: low

Declaration

public int? TopicMetadataRefreshIntervalMs { get; set; }

Property Value

Type	Description
int?

TopicMetadataRefreshSparse

Sparse metadata requests (consumes less network bandwidth)

default: true
importance: low

Declaration

public bool? TopicMetadataRefreshSparse { get; set; }

Property Value

Type	Description
bool?

Methods

Validate()

Throws an EndpointConfigurationException if the current configuration is not valid.

Declaration

public abstract void Validate()

Implements

IValidatableEndpointSettings