docs
API
Generated with
docs/zio.kafka.admin/AdminClient

AdminClient

zio.kafka.admin.AdminClient
See theAdminClient companion object
trait AdminClient

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Abstract methods

def alterConfigs(configs: Map[ConfigResource, KafkaConfig], options: AlterConfigsOptions): Task[Unit]

Update the configuration for the specified resources.

Update the configuration for the specified resources.

If you are using brokers with version 2.3.0 or higher, please use incrementalAlterConfigs instead.

Attributes

def alterConfigsAsync(configs: Map[ConfigResource, KafkaConfig], options: AlterConfigsOptions): Task[Map[ConfigResource, Task[Unit]]]

Update the configuration for the specified resources async.

Update the configuration for the specified resources async.

If you are using brokers with version 2.3.0 or higher, please use incrementalAlterConfigs instead.

Attributes

def alterConsumerGroupOffsets(groupId: String, offsets: Map[TopicPartition, OffsetAndMetadata], options: Option[AlterConsumerGroupOffsetsOptions]): Task[Unit]

Alter offsets for the specified partitions and consumer group.

Alter offsets for the specified partitions and consumer group.

Attributes

def createAcls(acls: Set[AclBinding], options: Option[CreateAclOptions]): Task[Unit]

Creates access control lists (ACLs) which are bound to specific resources.

Creates access control lists (ACLs) which are bound to specific resources.

Attributes

def createAclsAsync(acls: Set[AclBinding], options: Option[CreateAclOptions]): Task[Map[AclBinding, Task[Unit]]]

Creates access control lists (ACLs) which are bound to specific resources async.

Creates access control lists (ACLs) which are bound to specific resources async.

Attributes

def createPartitions(newPartitions: Map[String, NewPartitions], options: Option[CreatePartitionsOptions]): Task[Unit]

Add new partitions to a topic.

Add new partitions to a topic.

Attributes

def createTopic(newTopic: NewTopic, validateOnly: Boolean): Task[Unit]

Create a single topic.

Create a single topic.

Attributes

def createTopics(newTopics: Iterable[NewTopic], options: Option[CreateTopicsOptions]): Task[Unit]

Create multiple topics.

Create multiple topics.

Attributes

def deleteAcls(filters: Set[AclBindingFilter], options: Option[DeleteAclsOptions]): Task[Set[AclBinding]]

Deletes access control lists (ACLs) according to the supplied filters.

Deletes access control lists (ACLs) according to the supplied filters.

Attributes

def deleteAclsAsync(filters: Set[AclBindingFilter], options: Option[DeleteAclsOptions]): Task[Map[AclBindingFilter, Task[Map[AclBinding, Option[Throwable]]]]]

Deletes access control lists (ACLs) according to the supplied filters async.

Deletes access control lists (ACLs) according to the supplied filters async.

Attributes

def deleteConsumerGroups(groupIds: Iterable[String], options: Option[DeleteConsumerGroupOptions]): Task[Unit]

Delete consumer groups.

Delete consumer groups.

Attributes

def deleteRecords(recordsToDelete: Map[TopicPartition, RecordsToDelete], deleteRecordsOptions: Option[DeleteRecordsOptions]): Task[Unit]

Delete records.

Delete records.

Attributes

def deleteTopic(topic: String): Task[Unit]

Delete a single topic.

Delete a single topic.

Attributes

def deleteTopics(topics: Iterable[String], options: Option[DeleteTopicsOptions]): Task[Unit]

Delete multiple topics.

Delete multiple topics.

Attributes

def describeClusterAuthorizedOperations(options: Option[DescribeClusterOptions]): Task[Set[AclOperation]]

Get the cluster authorized operations.

Get the cluster authorized operations.

Attributes

def describeClusterController(options: Option[DescribeClusterOptions]): Task[Option[Node]]

Get the cluster controller.

Get the cluster controller.

Attributes

def describeClusterId(options: Option[DescribeClusterOptions]): Task[String]

Get the cluster id.

Get the cluster id.

Attributes

def describeClusterNodes(options: Option[DescribeClusterOptions]): Task[List[Node]]

Get the cluster nodes.

Get the cluster nodes.

Attributes

def describeConfigs(configResources: Iterable[ConfigResource], options: Option[DescribeConfigsOptions]): Task[Map[ConfigResource, KafkaConfig]]

Get the configuration for the specified resources.

Get the configuration for the specified resources.

Attributes

def describeConfigsAsync(configResources: Iterable[ConfigResource], options: Option[DescribeConfigsOptions]): Task[Map[ConfigResource, Task[KafkaConfig]]]

Get the configuration for the specified resources async.

Get the configuration for the specified resources async.

Attributes

def describeConsumerGroups(groupIds: String*): Task[Map[String, ConsumerGroupDescription]]

Describe the specified consumer groups.

Describe the specified consumer groups.

Attributes

def describeConsumerGroups(groupIds: List[String], options: Option[DescribeConsumerGroupsOptions]): Task[Map[String, ConsumerGroupDescription]]

Describe the specified consumer groups.

Describe the specified consumer groups.

Attributes

def describeLogDirs(brokersId: Iterable[Int]): ZIO[Any, Throwable, Map[Int, Map[String, LogDirDescription]]]

Describe the log directories of the specified brokers

Describe the log directories of the specified brokers

Attributes

def describeLogDirsAsync(brokersId: Iterable[Int]): ZIO[Any, Throwable, Map[Int, Task[Map[String, LogDirDescription]]]]

Describe the log directories of the specified brokers async

Describe the log directories of the specified brokers async

Attributes

def describeTopics(topicNames: Iterable[String], options: Option[DescribeTopicsOptions]): Task[Map[String, TopicDescription]]

Describe the specified topics.

Describe the specified topics.

Attributes

def incrementalAlterConfigs(configs: Map[ConfigResource, Iterable[AlterConfigOp]], options: AlterConfigsOptions): Task[Unit]

Incrementally update the configuration for the specified resources. Only supported by brokers with version 2.3.0 or higher. Use alterConfigs otherwise.

Incrementally update the configuration for the specified resources. Only supported by brokers with version 2.3.0 or higher. Use alterConfigs otherwise.

Attributes

def incrementalAlterConfigsAsync(configs: Map[ConfigResource, Iterable[AlterConfigOp]], options: AlterConfigsOptions): Task[Map[ConfigResource, Task[Unit]]]

Incrementally update the configuration for the specified resources async. Only supported by brokers with version 2.3.0 or higher. Use alterConfigsAsync otherwise.

Incrementally update the configuration for the specified resources async. Only supported by brokers with version 2.3.0 or higher. Use alterConfigsAsync otherwise.

Attributes

def listConsumerGroupOffsets(groupId: String, options: Option[ListConsumerGroupOffsetsOptions]): Task[Map[TopicPartition, OffsetAndMetadata]]

List Consumer Group offsets for the specified partitions.

List Consumer Group offsets for the specified partitions.

Attributes

def listConsumerGroupOffsets(groupSpecs: Map[String, ListConsumerGroupOffsetsSpec]): Task[Map[String, Map[TopicPartition, OffsetAndMetadata]]]

Given a mapping of consumer group IDs and list of partitions, list the consumer group offsets available in the cluster for the specified consumer groups and partitions.

Given a mapping of consumer group IDs and list of partitions, list the consumer group offsets available in the cluster for the specified consumer groups and partitions.

Attributes

def listConsumerGroupOffsets(groupSpecs: Map[String, ListConsumerGroupOffsetsSpec], options: ListConsumerGroupOffsetsOptions): Task[Map[String, Map[TopicPartition, OffsetAndMetadata]]]

Given a mapping of consumer group IDs and list of partitions, list the consumer group offsets available in the cluster for the specified consumer groups and partitions.

Given a mapping of consumer group IDs and list of partitions, list the consumer group offsets available in the cluster for the specified consumer groups and partitions.

Attributes

def listConsumerGroups(options: Option[ListConsumerGroupsOptions]): Task[List[ConsumerGroupListing]]

List the consumer groups in the cluster.

List the consumer groups in the cluster.

Attributes

def listOffsets(topicPartitionOffsets: Map[TopicPartition, OffsetSpec], options: Option[ListOffsetsOptions]): Task[Map[TopicPartition, ListOffsetsResultInfo]]

List offset for the specified partitions.

List offset for the specified partitions.

Attributes

def listOffsetsAsync(topicPartitionOffsets: Map[TopicPartition, OffsetSpec], options: Option[ListOffsetsOptions]): Task[Map[TopicPartition, Task[ListOffsetsResultInfo]]]

List offset for the specified partitions.

List offset for the specified partitions.

Attributes

def listTopics(listTopicsOptions: Option[ListTopicsOptions]): Task[Map[String, TopicListing]]

List the topics in the cluster.

List the topics in the cluster.

Attributes

def metrics: Task[Map[MetricName, Metric]]

Retrieves metrics for the underlying AdminClient

Retrieves metrics for the underlying AdminClient

Attributes

def removeMembersFromConsumerGroup(groupId: String, membersToRemove: Set[String]): Task[Unit]

Remove the specified members from a consumer group.

Remove the specified members from a consumer group.

Attributes

Generated with