Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TopicDescription

A detailed description of a single topic in the cluster

Hierarchy

  • TopicDescription

Index

Constructors

Methods

Constructors

constructor

Methods

getAuthorizedOperations

  • getAuthorizedOperations(): any[]

  • Set the id of the consumer group

    Returns any[]

getName

  • getName(): string

  • Set the name of the topic.

    Returns string

getPartitions

  • Set A list of partitions where the index represents the partition id and the element contains leadership and replica information for that partition.

    Returns TopicPartitionInfo[]

getTopicId

  • getTopicId(): any

  • Set the id of the topic.

    Returns any

isInternal

  • isInternal(): boolean

  • Set whether the topic is internal to Kafka.

    Returns boolean

setAuthorizedOperations

  • Set the id of the consumer group

    Parameters

    • authorizedOperations: any[]

    Returns TopicDescription

setInternal

  • Set whether the topic is internal to Kafka.

    Parameters

    • internal: boolean

    Returns TopicDescription

setName

  • Set the name of the topic.

    Parameters

    • name: string

    Returns TopicDescription

setPartitions

  • Set A list of partitions where the index represents the partition id and the element contains leadership and replica information for that partition.

    Parameters

    Returns TopicDescription

setTopicId

  • Set the id of the topic.

    Parameters

    • topicId: any

    Returns TopicDescription

toJson

  • toJson(): {}

  • Returns {}

    • [key: string]: any

Generated using TypeDoc