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

AdminClient

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

Attributes

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

Members list

Type members

Classlikes

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

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object AlterConfigOpType

Attributes

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

Attributes

Companion
object
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

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

Attributes

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

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ConfigResource

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object ConfigResourceType

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
trait ConfigResourceType

Attributes

Companion
object
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
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ConsumerGroupDescription

Attributes

Companion
class
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
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ConsumerGroupListing

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object ConsumerGroupState

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object KafkaConfig

Attributes

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

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ListConsumerGroupOffsetsOptions

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ListOffsetsResultInfo

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final implicit class ListOps[A](list: List[A]) extends AnyVal

Attributes

Supertypes
class AnyVal
trait Matchable
class Any
final case class ListTopicsOptions(listInternal: Boolean, timeout: Option[Duration])

Attributes

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

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object LogDirDescription

Attributes

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

Attributes

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
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object MemberDescription

Attributes

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

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Metric

Attributes

Companion
class
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
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object MetricName

Attributes

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

Attributes

Supertypes
class AnyVal
trait Matchable
class Any
final case class NewPartitions(totalCount: Int, newAssignments: List[List[Int]])

Attributes

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

Attributes

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

Value parameters

host

can't be empty string if present

id

= 0

port

can't be negative if present

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Node

Attributes

Companion
class
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
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object OffsetAndMetadata

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ReplicaInfo

Attributes

Companion
class
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
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object TopicDescription

Attributes

Companion
class
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
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object TopicListing

Attributes

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

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object TopicPartition

Attributes

Companion
class
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
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object TopicPartitionInfo

Attributes

Companion
class
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 fromScopedJavaClient[R, E](scopedJavaClient: ZIO[R & Scope, E, Admin]): ZIO[R & Scope, E, AdminClient]

Concrete fields

Implicits

Implicits

final implicit def ListOps[A](list: List[A]): ListOps[A]
final implicit def MapOps[K1, V1](v: Map[K1, V1]): MapOps[K1, V1]
final implicit def MutableMapOps[K1, V1](v: Map[K1, V1]): MutableMapOps[K1, V1]
final implicit def OptionOps[T](v: Option[T]): OptionOps[T]
final implicit def OptionalOps[T](v: Optional[T]): OptionalOps[T]
Generated with