KafkaAdminClient | @vertx/kafka-client

Vert.x Kafka Admin client implementation

Hierarchy

KafkaAdminClient

Index

Methods

close

close(): PromiseLike<void>
close(handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void
close(timeout: number): PromiseLike<void>
close(timeout: number, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:177
Close the admin client

Returns PromiseLike<void>
- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:182
Close the admin client

Parameters
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void
- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:187
Close the admin client

Parameters
- timeout: number
Returns PromiseLike<void>
- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:192
Close the admin client

Parameters
- timeout: number
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void

createAcls

createAcls(aclBindings: any): PromiseLike<any>
createAcls(aclBindings: any, completionHandler: ((res: AsyncResult<any>) => void) | Handler<AsyncResult<any>>): void

- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:207
Create the ACL rules.

Parameters
- aclBindings: any
Returns PromiseLike<any>
- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:212
Create the ACL rules.

Parameters
- aclBindings: any
- completionHandler: ((res: AsyncResult<any>) => void) | Handler<AsyncResult<any>>
Returns void

createPartitions

createPartitions(partitions: {}): PromiseLike<void>
createPartitions(partitions: {}, completionHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:93
Creates a batch of new partitions in the Kafka topic

Parameters
- partitions: {}
  - [key: string]: NewPartitions
Returns PromiseLike<void>
- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:98
Creates a batch of new partitions in the Kafka topic

Parameters
- partitions: {}
  - [key: string]: NewPartitions
- completionHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void

createTopics

createTopics(topics: NewTopic): PromiseLike<void>
createTopics(topics: NewTopic, completionHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:73
Creates a batch of new Kafka topics

Parameters
- topics: NewTopic
Returns PromiseLike<void>
- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:78
Creates a batch of new Kafka topics

Parameters
- topics: NewTopic
- completionHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void

deleteAcls

deleteAcls(aclBindings: any): PromiseLike<any>
deleteAcls(aclBindings: any, completionHandler: ((res: AsyncResult<any>) => void) | Handler<AsyncResult<any>>): void

- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:217
Delete the ACL rules.

Parameters
- aclBindings: any
Returns PromiseLike<any>
- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:222
Delete the ACL rules.

Parameters
- aclBindings: any
- completionHandler: ((res: AsyncResult<any>) => void) | Handler<AsyncResult<any>>
Returns void

deleteConsumerGroupOffsets

deleteConsumerGroupOffsets(groupId: string, partitions: TopicPartition): PromiseLike<void>
deleteConsumerGroupOffsets(groupId: string, partitions: TopicPartition, completionHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:165
Delete committed offsets for a set of partitions in a consumer group. This will succeed at the partition level only if the group is not actively subscribed to the corresponding topic.

Parameters
- groupId: string
- partitions: TopicPartition
Returns PromiseLike<void>
- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:172
Delete committed offsets for a set of partitions in a consumer group. This will succeed at the partition level only if the group is not actively subscribed to the corresponding topic.

Parameters
- groupId: string
- partitions: TopicPartition
- completionHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void

deleteConsumerGroups

deleteConsumerGroups(groupIds: string): PromiseLike<void>
deleteConsumerGroups(groupIds: string, completionHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:153
Delete consumer groups from the cluster.

Parameters
- groupIds: string
Returns PromiseLike<void>
- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:158
Delete consumer groups from the cluster.

Parameters
- groupIds: string
- completionHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void

deleteTopics

deleteTopics(topicNames: string): PromiseLike<void>
deleteTopics(topicNames: string, completionHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:83
Deletes a batch of Kafka topics

Parameters
- topicNames: string
Returns PromiseLike<void>
- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:88
Deletes a batch of Kafka topics

Parameters
- topicNames: string
- completionHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void

describeAcls

describeAcls(aclBindingFilter: any): PromiseLike<any>
describeAcls(aclBindingFilter: any, completionHandler: ((res: AsyncResult<any>) => void) | Handler<AsyncResult<any>>): void

- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:197
Describe the ACL rules.

Parameters
- aclBindingFilter: any
Returns PromiseLike<any>
- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:202
Describe the ACL rules.

Parameters
- aclBindingFilter: any
- completionHandler: ((res: AsyncResult<any>) => void) | Handler<AsyncResult<any>>
Returns void

describeCluster

describeCluster(): PromiseLike<ClusterDescription>
describeCluster(completionHandler: ((res: AsyncResult<ClusterDescription>) => void) | Handler<AsyncResult<ClusterDescription>>): void
describeCluster(options: DescribeClusterOptions): PromiseLike<ClusterDescription>
describeCluster(options: DescribeClusterOptions, completionHandler: ((res: AsyncResult<ClusterDescription>) => void) | Handler<AsyncResult<ClusterDescription>>): void

- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:133
Describe the nodes in the cluster with the default options

Returns PromiseLike<ClusterDescription>
- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:138
Describe the nodes in the cluster with the default options

Parameters
- completionHandler: ((res: AsyncResult<ClusterDescription>) => void) | Handler<AsyncResult<ClusterDescription>>
Returns void
- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:143
Like {@link KafkaAdminClient#describeCluster} but allows customized options.

Parameters
- options: DescribeClusterOptions
Returns PromiseLike<ClusterDescription>
- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:148
Like {@link KafkaAdminClient#describeCluster} but allows customized options.

Parameters
- options: DescribeClusterOptions
- completionHandler: ((res: AsyncResult<ClusterDescription>) => void) | Handler<AsyncResult<ClusterDescription>>
Returns void

describeConsumerGroups

describeConsumerGroups(groupIds: string): PromiseLike<{}>
describeConsumerGroups(groupIds: string, completionHandler: ((res: AsyncResult<{}>) => void) | Handler<AsyncResult<{}>>): void
describeConsumerGroups(groupIds: string, options: DescribeConsumerGroupsOptions): PromiseLike<{}>
describeConsumerGroups(groupIds: string, options: DescribeConsumerGroupsOptions, completionHandler: ((res: AsyncResult<{}>) => void) | Handler<AsyncResult<{}>>): void

- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:113
Describe some group ids in the cluster, with the default options

Parameters
- groupIds: string
Returns PromiseLike<{}>
- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:118
Describe some group ids in the cluster, with the default options

Parameters
- groupIds: string
- completionHandler: ((res: AsyncResult<{}>) => void) | Handler<AsyncResult<{}>>
Returns void
- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:123
Like {@link KafkaAdminClient#describeConsumerGroups} but allows customized options

Parameters
- groupIds: string
- options: DescribeConsumerGroupsOptions
Returns PromiseLike<{}>
- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:128
Like {@link KafkaAdminClient#describeConsumerGroups} but allows customized options

Parameters
- groupIds: string
- options: DescribeConsumerGroupsOptions
- completionHandler: ((res: AsyncResult<{}>) => void) | Handler<AsyncResult<{}>>
Returns void

describeTopics

describeTopics(topicNames: string): PromiseLike<{}>
describeTopics(topicNames: string, completionHandler: ((res: AsyncResult<{}>) => void) | Handler<AsyncResult<{}>>): void
describeTopics(topicNames: string, options: DescribeTopicsOptions): PromiseLike<{}>
describeTopics(topicNames: string, options: DescribeTopicsOptions, completionHandler: ((res: AsyncResult<{}>) => void) | Handler<AsyncResult<{}>>): void

- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:53
Describe some topics in the cluster, with the default options.

Parameters
- topicNames: string
Returns PromiseLike<{}>
- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:58
Describe some topics in the cluster, with the default options.

Parameters
- topicNames: string
- completionHandler: ((res: AsyncResult<{}>) => void) | Handler<AsyncResult<{}>>
Returns void
- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:63
Like {@link KafkaAdminClient#describeTopics} but allows for customised otions

Parameters
- topicNames: string
- options: DescribeTopicsOptions
Returns PromiseLike<{}>
- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:68
Like {@link KafkaAdminClient#describeTopics} but allows for customised otions

Parameters
- topicNames: string
- options: DescribeTopicsOptions
- completionHandler: ((res: AsyncResult<{}>) => void) | Handler<AsyncResult<{}>>
Returns void

listConsumerGroups

listConsumerGroups(): PromiseLike<ConsumerGroupListing>
listConsumerGroups(completionHandler: ((res: AsyncResult<ConsumerGroupListing>) => void) | Handler<AsyncResult<ConsumerGroupListing>>): void

- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:103
Get the the consumer groups available in the cluster with the default options

Returns PromiseLike<ConsumerGroupListing>
- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:108
Get the the consumer groups available in the cluster with the default options

Parameters
- completionHandler: ((res: AsyncResult<ConsumerGroupListing>) => void) | Handler<AsyncResult<ConsumerGroupListing>>
Returns void

listTopics

listTopics(): PromiseLike<string>
listTopics(completionHandler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>): void

- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:43
List the topics available in the cluster with the default options.

Returns PromiseLike<string>
- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:48
List the topics available in the cluster with the default options.

Parameters
- completionHandler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>
Returns void

Static create

create(vertx: Vertx, config: {}): KafkaAdminClient

- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:38
Create a new KafkaAdminClient instance

Parameters
- vertx: Vertx
- config: {}
  - [key: string]: string
Returns KafkaAdminClient

Hierarchy

Index

Methods

Methods

close

Returns PromiseLike<void>

Parameters

handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns void

Parameters

timeout: number

Returns PromiseLike<void>

Parameters

timeout: number

handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns void

createAcls

Parameters

aclBindings: any

Returns PromiseLike<any>

Parameters

aclBindings: any

completionHandler: ((res: AsyncResult<any>) => void) | Handler<AsyncResult<any>>

Returns void

createPartitions

Parameters

partitions: {}

[key: string]: NewPartitions

Returns PromiseLike<void>

Parameters

partitions: {}

[key: string]: NewPartitions

completionHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns void

createTopics

Parameters

topics: NewTopic

Returns PromiseLike<void>

Parameters

topics: NewTopic

completionHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns void

deleteAcls

Parameters

aclBindings: any

Returns PromiseLike<any>

Parameters

aclBindings: any

completionHandler: ((res: AsyncResult<any>) => void) | Handler<AsyncResult<any>>

Returns void

deleteConsumerGroupOffsets

Parameters

groupId: string

partitions: TopicPartition

Returns PromiseLike<void>

Parameters

groupId: string

partitions: TopicPartition

completionHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns void

deleteConsumerGroups

Parameters

groupIds: string

Returns PromiseLike<void>

Parameters

groupIds: string

completionHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns void

deleteTopics

Parameters

topicNames: string

Returns PromiseLike<void>

Parameters

topicNames: string

completionHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns void

describeAcls

Parameters

aclBindingFilter: any

Returns PromiseLike<any>