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 KafkaAdminClient.resource or KafkaAdminClient.stream to create an instance.

Source
KafkaAdminClient.scala
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. Protected

Abstract Value Members

  1. abstract def alterConfigs[G[_]](configs: Map[ConfigResource, G[AlterConfigOp]])(implicit G: Foldable[G]): F[Unit]

    Updates the configuration for the specified resources.

  2. abstract def alterConsumerGroupOffsets(groupId: String, offsets: Map[TopicPartition, OffsetAndMetadata]): F[Unit]

    Alters offsets for the specified group.

    Alters offsets for the specified group. In order to succeed, the group must be empty.

  3. abstract def createAcls[G[_]](acls: G[AclBinding])(implicit G: Foldable[G]): F[Unit]

    Creates the specified ACLs

  4. abstract def createPartitions(newPartitions: Map[String, NewPartitions]): F[Unit]

    Increase the number of partitions for different topics

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

    Creates the specified topic.

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

    Creates the specified topics.

  7. abstract def deleteAcls[G[_]](filters: G[AclBindingFilter])(implicit G: Foldable[G]): F[Unit]

    Deletes ACLs based on specified filters

  8. abstract def deleteConsumerGroupOffsets(groupId: String, partitions: Set[TopicPartition]): F[Unit]

    Delete committed offsets for a set of partitions in a consumer group.

    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.

  9. abstract def deleteTopic(topic: String): F[Unit]

    Deletes the specified topic.

  10. abstract def deleteTopics[G[_]](topics: G[String])(implicit G: Foldable[G]): F[Unit]

    Deletes the specified topics.

  11. abstract def describeAcls(filter: AclBindingFilter): F[List[AclBinding]]

    Describes the ACLs based on the specified filters, returning a List of AclBinding entries matched

  12. abstract def describeCluster: DescribeCluster[F]

    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
  13. abstract def describeConfigs[G[_]](resources: G[ConfigResource])(implicit G: Foldable[G]): F[Map[ConfigResource, List[ConfigEntry]]]

    Describes the configurations for the specified resources.

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

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

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

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

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

    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
  17. abstract def listConsumerGroups: ListConsumerGroups[F]

    Lists consumer groups.

    Lists consumer groups. Returns group ids using:

    listConsumerGroups.groupIds

    or ConsumerGroupListings using the following.

    listConsumerGroups.listings
  18. abstract def listTopics: ListTopics[F]

    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
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped