Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ConsumerGroupDescription

A detailed description of a single consumer group in the cluster

Hierarchy

  • ConsumerGroupDescription

Index

Constructors

constructor

Methods

getAuthorizedOperations

  • getAuthorizedOperations(): any[]
  • Set the id of the consumer group

    Returns any[]

getCoordinator

  • getCoordinator(): Node
  • Set the consumer group coordinator, or null if the coordinator is not known

    Returns Node

getGroupId

  • getGroupId(): string
  • Set the id of the consumer group

    Returns string

getMembers

  • Set a list of the members of the consumer group

    Returns MemberDescription[]

getPartitionAssignor

  • getPartitionAssignor(): string
  • Set the consumer group partition assignor

    Returns string

getState

  • getState(): any
  • Set the consumer group state, or UNKNOWN if the state is too new for us to parse

    Returns any

isSimpleConsumerGroup

  • isSimpleConsumerGroup(): boolean
  • Set if consumer group is simple or not

    Returns boolean

setAuthorizedOperations

  • Set the id of the consumer group

    Parameters

    • authorizedOperations: any[]

    Returns ConsumerGroupDescription

setCoordinator

  • Set the consumer group coordinator, or null if the coordinator is not known

    Parameters

    Returns ConsumerGroupDescription

setGroupId

  • Set the id of the consumer group

    Parameters

    • groupId: string

    Returns ConsumerGroupDescription

setMembers

setPartitionAssignor

  • Set the consumer group partition assignor

    Parameters

    • partitionAssignor: string

    Returns ConsumerGroupDescription

setSimpleConsumerGroup

  • Set if consumer group is simple or not

    Parameters

    • simpleConsumerGroup: boolean

    Returns ConsumerGroupDescription

setState

  • Set the consumer group state, or UNKNOWN if the state is too new for us to parse

    Parameters

    • state: any

    Returns ConsumerGroupDescription

toJson

  • toJson(): {}
  • Returns {}

    • [key: string]: any

Generated using TypeDoc