AdminClient

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

Attributes

Companion:
trait
Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Concise view

Type members

Classlikes

final case class AlterConfigOp(configEntry: ConfigEntry, opType: AlterConfigOpType)

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Attributes

Companion:
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait AlterConfigOpType

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Append.type
object Delete.type
object Set.type
object Substract.type
final case class AlterConfigsOptions(validateOnly: Boolean, timeout: Option[Duration])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
final case class AlterConsumerGroupOffsetsOptions(timeout: Option[Duration])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
final case class ConfigResource(`type`: ConfigResourceType, name: String)

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type

Attributes

Companion:
trait
Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Broker.type
object BrokerLogger.type
object Topic.type
object Unknown.type
final case class ConsumerGroupDescription(groupId: String, isSimpleConsumerGroup: Boolean, members: List[MemberDescription], partitionAssignor: String, state: ConsumerGroupState, coordinator: Option[Node], authorizedOperations: Set[AclOperation])

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ConsumerGroupListing(groupId: String, isSimple: Boolean, state: Option[ConsumerGroupState])

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type

Attributes

Companion:
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait ConsumerGroupState

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Dead.type
object Empty.type
object PreparingRebalance.type
object Stable.type
object Unknown.type
final case class CreatePartitionsOptions(validateOnly: Boolean, retryOnQuotaViolation: Boolean, timeout: Option[Duration])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
final case class CreateTopicsOptions(validateOnly: Boolean, timeout: Option[Duration])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
final case class DeleteConsumerGroupOptions(timeout: Option[Duration])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
final case class DeleteRecordsOptions(timeout: Option[Duration])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
final case class DeleteTopicsOptions(retryOnQuotaViolation: Boolean, timeout: Option[Duration])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
final case class DescribeClusterOptions(includeAuthorizedOperations: Boolean, timeout: Option[Duration])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
final case class DescribeConfigsOptions(includeSynonyms: Boolean, includeDocumentation: Boolean, timeout: Option[Duration])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
final case class DescribeConsumerGroupsOptions(includeAuthorizedOperations: Boolean, timeout: Option[Duration])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
final case class DescribeTopicsOptions(includeAuthorizedOperations: Boolean, timeout: Option[Duration])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
sealed abstract class IsolationLevel

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object ReadCommitted.type
object ReadUncommitted.type

Attributes

Companion:
class
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class KafkaConfig(entries: Map[String, ConfigEntry])

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ListConsumerGroupOffsetsOptions(partitions: Chunk[TopicPartition])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
final case class ListConsumerGroupsOptions(states: Set[ConsumerGroupState])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
final case class ListOffsetsOptions(isolationLevel: IsolationLevel, timeout: Option[Duration])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
final case class ListOffsetsResultInfo(offset: Long, timestamp: Long, leaderEpoch: Option[Int])

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ListTopicsOptions(listInternal: Boolean, timeout: Option[Duration])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
final case class LogDirDescription(error: ApiException, replicaInfos: Map[TopicPartition, ReplicaInfo])

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final implicit class MapOps[K1, V1](val v: Map[K1, V1]) extends AnyVal

Attributes

Graph
Supertypes
class AnyVal
trait Matchable
class Any
final case class MemberDescription(consumerId: String, groupInstanceId: Option[String], clientId: String, host: String, assignment: Set[TopicPartition])

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class Metric(name: MetricName, metricValue: AnyRef)

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object Metric

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Metric.type
final case class MetricName(name: String, group: String, description: String, tags: Map[String, String])

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object MetricName

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class NewPartitions(totalCount: Int, newAssignments: List[List[Int]])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
final case class NewTopic(name: String, numPartitions: Int, replicationFactor: Short, configs: Map[String, String])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
final case class Node(id: Int, host: Option[String], port: Option[Int], rack: Option[String])

Attributes

host

can't be empty string if present

id

= 0

port

can't be negative if present

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object Node

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Node.type
final case class OffsetAndMetadata(offset: Long, leaderEpoch: Option[Int], metadata: Option[String])

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed abstract class OffsetSpec

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object EarliestSpec.type
object LatestSpec.type
object OffsetSpec

Attributes

Companion:
class
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
final implicit class OptionOps[T](val v: Option[T]) extends AnyVal

Attributes

Graph
Supertypes
class AnyVal
trait Matchable
class Any
final implicit class OptionalOps[T](val v: Optional[T]) extends AnyVal

Attributes

Graph
Supertypes
class AnyVal
trait Matchable
class Any
final case class ReplicaInfo(size: Long, offsetLag: Long, isFuture: Boolean)

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class TopicDescription(name: String, internal: Boolean, partitions: List[TopicPartitionInfo], authorizedOperations: Option[Set[AclOperation]])

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class TopicListing(name: String, topicId: Uuid, isInternal: Boolean)

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class TopicPartition(name: String, partition: Int)

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class TopicPartitionInfo(partition: Int, leader: Option[Node], replicas: List[Node], isr: List[Node])

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type

Value members

Concrete methods

def fromJavaClient(javaClient: Admin): URIO[Any, AdminClient]
def fromKafkaFuture[R, T](kfv: RIO[R, KafkaFuture[T]]): RIO[R, T]
def fromKafkaFutureVoid[R](kfv: RIO[R, KafkaFuture[Void]]): RIO[R, Unit]
def fromManagedJavaClient[R, E](managedJavaClient: ZIO[R & Scope, E, Admin]): ZIO[R & Scope, E, AdminClient]
def javaClientFromSettings(settings: AdminClientSettings): ZIO[Scope, Throwable, Admin]
def make(settings: AdminClientSettings): ZIO[Scope, Throwable, AdminClient]

Concrete fields

val live: ZLayer[AdminClientSettings, Throwable, AdminClient]

Implicits

Implicits

final implicit def MapOps[K1, V1](v: Map[K1, V1]): MapOps[K1, V1]
final implicit def OptionOps[T](v: Option[T]): OptionOps[T]
final implicit def OptionalOps[T](v: Optional[T]): OptionalOps[T]