xk6-kafka

---

Class: AdminClient

Defined in: index.d.ts:482

Classdesc

AdminClient connects to Kafka for topic administration.

Example

// In init context
const adminClient = new AdminClient({
  brokers: ["localhost:9092"],
});

// In VU code (default function)
const topics = adminClient.listTopics();

// In teardown function
adminClient.close();

Constructors

Constructor

new AdminClient(connectionConfig): AdminClient

Defined in: index.d.ts:483

Parameters

connectionConfig

ConnectionConfig

Returns

AdminClient

Methods

close()

close(): void

Defined in: index.d.ts:488

Returns

void

---

createTopic()

createTopic(topicConfig): void

Defined in: index.d.ts:484

Parameters

topicConfig

TopicConfig

Returns

void

---

deleteTopic()

deleteTopic(topic): void

Defined in: index.d.ts:485

Parameters

topic

string

Returns

void

---

getMetadata()

getMetadata(topic): TopicMetadata

Defined in: index.d.ts:487

Parameters

topic

string

Returns

TopicMetadata

---

listTopics()

listTopics(): TopicInfo[]

Defined in: index.d.ts:486

Returns

TopicInfo[]