Type Alias ProduceRequest

Produce request payload.

type ProduceRequest = {
    acks: Acks;
    taggedFields?: readonly TaggedField[];
    timeoutMs: number;
    topics: readonly ProduceTopicData[];
    transactionalId?: string | null;
}

Index

Properties

acks taggedFields? timeoutMs topics transactionalId?

Properties

`Readonly`acks

acks: Acks

The number of acknowledgements required.

-1 (All): All in-sync replicas
0 (None): No acknowledgement
1 (Leader): Leader only

`Optional` `Readonly`taggedFields

taggedFields?: readonly TaggedField[]

Tagged fields (v9+).

`Readonly`timeoutMs

timeoutMs: number

Timeout in milliseconds to wait for the required acknowledgements.

`Readonly`topics

topics: readonly ProduceTopicData[]

Topic data to produce.

`Optional` `Readonly`transactionalId

transactionalId?: string | null

The transactional ID (v3+). Null for non-transactional producers.