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 abortTransaction(topicPartition: TopicPartition, producerId: Long, producerEpoch: Short, coordinationEpoch: Int): F[Unit]

    Forcefully abort a transaction which is open on a topic partition.

  2. abstract def addRaftVoter(voterId: Int, voterDirectoryId: Uuid, endpoints: Set[RaftVoterEndpoint], clusterId: Option[String]): F[Unit]

    Add a new voter node to the KRaft metadata quorum.

  3. abstract def alterClientQuotas[G[_]](entries: G[ClientQuotaAlteration])(implicit arg0: Foldable[G]): F[Unit]

    Alters client quota configurations with the specified alterations.

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

    Incrementally update the configuration for the specified resources.

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

    Updates the configuration for the specified resources.

  6. 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.

  7. abstract def alterPartitionReassignments(reassignments: Map[TopicPartition, Option[NewPartitionReassignment]]): F[Unit]

    Change the reassignments for one or more partitions.

  8. abstract def alterReplicaLogDirs(replicaAssignment: Map[TopicPartitionReplica, String]): F[Unit]

    Change the log directory for the specified replicas.

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

    Creates the specified ACLs

  10. abstract def createDelegationToken(renewers: List[KafkaPrincipal], owner: Option[KafkaPrincipal], maxLifeTime: Option[FiniteDuration]): F[DelegationToken]

    Creates a delegation token

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

    Increase the number of partitions for different topics

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

    Creates the specified topic.

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

    Creates the specified topics.

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

    Deletes ACLs based on specified filters

  15. 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.

  16. abstract def deleteConsumerGroups[G[_]](groupIds: G[String])(implicit G: Foldable[G]): F[Unit]

    Delete consumer groups from the cluster.

  17. abstract def deleteRecords(recordsToDelete: Map[TopicPartition, RecordsToDelete]): F[Unit]

    Delete records whose offset is smaller than the given offset of the corresponding partition.

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

    Deletes the specified topic.

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

    Deletes the specified topics.

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

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

  21. abstract def describeClientQuotas(filter: ClientQuotaFilter): F[Map[ClientQuotaEntity, Map[String, Double]]]

    Describes all entities matching the provided filter that have at least one client quota configuration value defined.

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

    Describes the configurations for the specified resources.

  24. 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.

  25. abstract def describeDelegationToken[G[_]](owners: Option[G[KafkaPrincipal]])(implicit arg0: Foldable[G]): F[List[DelegationToken]]

    Describe the delegation tokens.

  26. abstract def describeFeatures: F[FeatureMetadata]

    Describes finalized as well as supported features.

  27. abstract def describeLogDirs[G[_]](brokers: G[Int])(implicit arg0: Foldable[G]): F[Map[Int, Map[String, LogDirDescription]]]

    Query the information of all log directories on the given set of brokers.

  28. abstract def describeMetadataQuorum: F[QuorumInfo]

    Describes the state of the metadata quorum.

  29. abstract def describeProducers[G[_]](partitions: G[TopicPartition], brokerId: Option[Int])(implicit arg0: Foldable[G]): F[Map[TopicPartition, PartitionProducerState]]

    Describe producer state on a set of topic partitions.

  30. abstract def describeReplicaLogDirs[G[_]](replicas: G[TopicPartitionReplica])(implicit arg0: Foldable[G]): F[Map[TopicPartitionReplica, ReplicaLogDirInfo]]

    Query the replica log directory information for the specified replicas.

  31. 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.

  32. abstract def describeTransactions[G[_]](transactionalIds: G[String])(implicit arg0: Foldable[G]): F[Map[String, TransactionDescription]]

    Describe the state of a set of transactional IDs from the respective transaction coordinators, which are dynamically discovered.

  33. abstract def describeUserScramCredentials(users: Option[List[String]]): F[Map[String, UserScramCredentialsDescription]]

    Describe all SASL/SCRAM credentials.

  34. abstract def electLeaders(electionType: ElectionType, partitions: Set[TopicPartition]): F[Unit]

    Elect a replica as leader for topic partitions.

  35. abstract def expireDelegationToken(hmac: Chunk[Byte], expiryTime: Option[FiniteDuration]): F[Instant]

    Expire a delegation token, returning the expiry timestamp.

  36. abstract def fenceProducers[G[_]](transactionalIds: G[String])(implicit arg0: Foldable[G]): F[Unit]

    Fence out all active producers that use any of the provided transactional IDs.

  37. abstract def listConfigResources: F[List[ConfigResource]]
  38. 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
  39. abstract def listConsumerGroups: ListConsumerGroups[F]

    Lists consumer groups.

    Lists consumer groups. Returns group ids using:

    listConsumerGroups.groupIds

    or ConsumerGroupListings using the following.

    listConsumerGroups.listings
  40. abstract def listOffsets(topicPartitionOffsets: Map[TopicPartition, OffsetSpec], isolationLevel: org.apache.kafka.common.IsolationLevel): F[Map[TopicPartition, ListOffsetsResultInfo]]

    List offset for the specified partitions and isolation level.

  41. abstract def listPartitionReassignments(partitionsFilter: Option[Set[TopicPartition]]): F[Map[TopicPartition, PartitionReassignment]]

    List the current reassignments for the given partitions.

  42. 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
  43. abstract def listTransactions(states: Option[Set[TransactionState]], producerIds: Option[Set[Long]], duration: Option[Long]): F[List[TransactionListing]]

    List active transactions in the cluster.

  44. abstract def metrics: F[Map[MetricName, Metric]]

    Get the metrics kept by the admin client.

  45. abstract def removeMembersFromConsumerGroup[G[_]](groupId: String, members: G[MemberToRemove], reason: Option[String])(implicit arg0: Foldable[G]): F[Unit]

    Remove members from the consumer group by given member identities.

  46. abstract def removeRaftVoter(voterId: Int, voterDirectoryId: Uuid, clusterId: Option[String]): F[Unit]

    Remove a voter node from the KRaft metadata quorum.

  47. abstract def renewDelegationToken(hmac: Chunk[Byte], renewTime: Option[FiniteDuration]): F[Instant]

    Renew a delegation token and return the expiry timestamp.

  48. abstract def updateFeatures(features: Map[String, FeatureUpdate], validateOnly: Boolean): F[Unit]

    Applies specified updates to finalized features.

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