Class/Object

fs2.kafka

KafkaAdminClient

Related Docs: object KafkaAdminClient | package kafka

Permalink

sealed abstract class KafkaAdminClient[F[_]] extends AnyRef

KafkaAdminClient represents an admin client for Kafka, which is able to describe queries about topics, consumer groups, offsets, and other entities related to Kafka.

Use adminClientResource or adminClientStream to create an instance.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. KafkaAdminClient
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def createTopic(topic: NewTopic): F[Unit]

    Permalink

    Creates the specified topic.

  2. abstract def createTopics[G[_]](topics: G[NewTopic])(implicit G: Foldable[G]): F[Unit]

    Permalink

    Creates the specified topics.

  3. abstract def describeCluster: DescribeCluster[F]

    Permalink

    Describes the cluster.

    Describes the cluster. Returns nodes using:

    describeCluster.nodes

    or the controller node using:

    describeCluster.controller

    or the cluster ID using the following.

    describeCluster.clusterId

  4. abstract def describeConsumerGroups[G[_]](groupIds: G[String])(implicit G: Foldable[G]): F[Map[String, ConsumerGroupDescription]]

    Permalink

    Describes the consumer groups with the specified group ids, returning a Map with group ids as keys, and ConsumerGroupDescriptions as values.

  5. abstract def describeTopics[G[_]](topics: G[String])(implicit G: Foldable[G]): F[Map[String, TopicDescription]]

    Permalink

    Describes the topics with the specified topic names, returning a Map with topic names as keys, and TopicDescriptions as values.

  6. abstract def listConsumerGroupOffsets(groupId: String): ListConsumerGroupOffsets[F]

    Permalink

    Lists consumer group offsets.

    Lists consumer group offsets. Returns offsets per topic-partition using:

    listConsumerGroupOffsets(groupId)
  .partitionsToOffsetAndMetadata

    or only offsets for specified topic-partitions using the following.

    listConsumerGroupOffsets(groupId)
  .forPartitions(topicPartitions)
  .partitionsToOffsetAndMetadata

  7. abstract def listConsumerGroups: ListConsumerGroups[F]

    Permalink

    Lists consumer groups.

    Lists consumer groups. Returns group ids using:

    listConsumerGroups.groupIds

    or ConsumerGroupListings using the following.

    listConsumerGroups.listings

  8. abstract def listTopics: ListTopics[F]

    Permalink

    Lists topics.

    Lists topics. Returns topic names using:

    listTopics.names

    or TopicListings using:

    listTopics.listings

    or a Map of topic names to TopicListings using the following.

    listTopics.namesToListings

    If you want to include internal topics, first use includeInternal.

    listTopics.includeInternal.listings

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  15. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  16. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  17. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  18. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  19. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped