Interface TopicProducerConfig

Configuration options for a topic producer

interface TopicProducerConfig {
    batchQueueSize?: number;
    batchSize?: number;
    compression?:
        | "none"
        | "gzip"
        | "snappy"
        | "lz4";
    lingerMs?: number;
    maxRequestSize?: number;
    timeoutMs?: number;
}

Properties

batchQueueSize? batchSize? compression? lingerMs? maxRequestSize? timeoutMs?

Properties

OptionalbatchQueueSize

batchQueueSize?: number

Maximum number of records to include in a batch

OptionalbatchSize

batchSize?: number

Maximum size of a batch before it's sent automatically (in bytes)

Optionalcompression

compression?:
    | "none"
    | "gzip"
    | "snappy"
    | "lz4"

Compression algorithm to use for batches Supported values: "none", "gzip", "snappy", "lz4"

OptionallingerMs

lingerMs?: number

Time in milliseconds to wait for additional records before sending a batch

OptionalmaxRequestSize

maxRequestSize?: number

Maximum size of a single request in bytes

OptionaltimeoutMs

timeoutMs?: number

Maximum time in milliseconds to wait before sending a batch, even if not full

Settings

Member Visibility

On This Page

batchQueueSizebatchSizecompressionlingerMsmaxRequestSizetimeoutMs