Class ConsumerGroupDescription

A detailed description of a single consumer group in the cluster

Hierarchy

ConsumerGroupDescription

Index

Constructors

constructor

Methods

Constructors

constructor

new ConsumerGroupDescription(): ConsumerGroupDescription
new ConsumerGroupDescription(obj: ConsumerGroupDescription | {}): ConsumerGroupDescription

- Defined in io.vertx/vertx-kafka-client/target/npm/options.d.ts:270
Returns ConsumerGroupDescription
- Defined in io.vertx/vertx-kafka-client/target/npm/options.d.ts:272
Parameters
- obj: ConsumerGroupDescription | {}
Returns ConsumerGroupDescription

Methods

getAuthorizedOperations

getAuthorizedOperations(): any[]

- Defined in io.vertx/vertx-kafka-client/target/npm/options.d.ts:279
Set the id of the consumer group

Returns any[]

getCoordinator

getCoordinator(): Node

- Defined in io.vertx/vertx-kafka-client/target/npm/options.d.ts:289
Set the consumer group coordinator, or null if the coordinator is not known

Returns Node

getGroupId

getGroupId(): string

- Defined in io.vertx/vertx-kafka-client/target/npm/options.d.ts:299
Set the id of the consumer group

Returns string

getMembers

getMembers(): MemberDescription[]

- Defined in io.vertx/vertx-kafka-client/target/npm/options.d.ts:309
Set a list of the members of the consumer group

Returns MemberDescription[]

getPartitionAssignor

getPartitionAssignor(): string

- Defined in io.vertx/vertx-kafka-client/target/npm/options.d.ts:319
Set the consumer group partition assignor

Returns string

getState

getState(): any

- Defined in io.vertx/vertx-kafka-client/target/npm/options.d.ts:339
Set the consumer group state, or UNKNOWN if the state is too new for us to parse

Returns any

isSimpleConsumerGroup

isSimpleConsumerGroup(): boolean

- Defined in io.vertx/vertx-kafka-client/target/npm/options.d.ts:329
Set if consumer group is simple or not

Returns boolean

setAuthorizedOperations

setAuthorizedOperations(authorizedOperations: any[]): ConsumerGroupDescription

- Defined in io.vertx/vertx-kafka-client/target/npm/options.d.ts:284
Set the id of the consumer group

Parameters
- authorizedOperations: any[]
Returns ConsumerGroupDescription

setCoordinator

setCoordinator(coordinator: Node): ConsumerGroupDescription

- Defined in io.vertx/vertx-kafka-client/target/npm/options.d.ts:294
Set the consumer group coordinator, or null if the coordinator is not known

Parameters
- coordinator: Node
Returns ConsumerGroupDescription

setGroupId

setGroupId(groupId: string): ConsumerGroupDescription

- Defined in io.vertx/vertx-kafka-client/target/npm/options.d.ts:304
Set the id of the consumer group

Parameters
- groupId: string
Returns ConsumerGroupDescription

setMembers

setMembers(members: MemberDescription[]): ConsumerGroupDescription

- Defined in io.vertx/vertx-kafka-client/target/npm/options.d.ts:314
Set a list of the members of the consumer group

Parameters
- members: MemberDescription[]
Returns ConsumerGroupDescription

setPartitionAssignor

setPartitionAssignor(partitionAssignor: string): ConsumerGroupDescription

- Defined in io.vertx/vertx-kafka-client/target/npm/options.d.ts:324
Set the consumer group partition assignor

Parameters
- partitionAssignor: string
Returns ConsumerGroupDescription

setSimpleConsumerGroup

setSimpleConsumerGroup(simpleConsumerGroup: boolean): ConsumerGroupDescription

- Defined in io.vertx/vertx-kafka-client/target/npm/options.d.ts:334
Set if consumer group is simple or not

Parameters
- simpleConsumerGroup: boolean
Returns ConsumerGroupDescription

setState

setState(state: any): ConsumerGroupDescription

- Defined in io.vertx/vertx-kafka-client/target/npm/options.d.ts:344
Set the consumer group state, or UNKNOWN if the state is too new for us to parse

Parameters
- state: any
Returns ConsumerGroupDescription

toJson

toJson(): {}

- Defined in io.vertx/vertx-kafka-client/target/npm/options.d.ts:347
Returns {}
- [key: string]: any

Generated using TypeDoc