Type Alias MetadataResponse

Metadata response payload.

type MetadataResponse = {
    brokers: readonly MetadataBroker[];
    clusterAuthorisedOperations: number;
    clusterId: string | null;
    controllerId: number;
    taggedFields: readonly TaggedField[];
    throttleTimeMs: number;
    topics: readonly MetadataTopic[];
}

Index

Properties

brokers clusterAuthorisedOperations clusterId controllerId taggedFields throttleTimeMs topics

Properties

`Readonly`brokers

brokers: readonly MetadataBroker[]

Broker information.

`Readonly`clusterAuthorisedOperations

clusterAuthorisedOperations: number

Cluster-level authorised operations bitmask (v8–v10).

`Readonly`clusterId

clusterId: string | null

Cluster ID (v2+). Null if not available.

`Readonly`controllerId

controllerId: number

Controller broker ID (v1+). -1 if unknown.

`Readonly`taggedFields

taggedFields: readonly TaggedField[]

Tagged fields (v9+).

`Readonly`throttleTimeMs

throttleTimeMs: number

Time the request was throttled in milliseconds (v3+).

`Readonly`topics

topics: readonly MetadataTopic[]

Topic metadata.