Type Alias RequestHeader

Fields for a Kafka request header.

Which fields are actually encoded depends on the header version:

v0: apiKey, apiVersion, correlationId
v1: v0 + clientId
v2: v1 + taggedFields (compact encoding)

type RequestHeader = {
    apiKey: ApiKey;
    apiVersion: number;
    clientId?: string | null;
    correlationId: number;
    taggedFields?: readonly TaggedField[];
}

Index

Properties

apiKey apiVersion clientId? correlationId taggedFields?

Properties

`Readonly`apiKey

apiKey: ApiKey

API key identifying the request type.

`Readonly`apiVersion

apiVersion: number

API version for this request.

`Optional` `Readonly`clientId

clientId?: string | null

Client identifier. Used in v1+ headers.

`Readonly`correlationId

correlationId: number

Correlation ID to match responses to requests.

`Optional` `Readonly`taggedFields

taggedFields?: readonly TaggedField[]

Tagged fields for flexible versions (v2).