docs
API
Generated with
docs/zio.kafka.consumer/Subscription

Subscription

zio.kafka.consumer.Subscription$
See theSubscription companion trait
object Subscription

Attributes

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

Members list

Concise view

Type members

Classlikes

final case class Manual(topicPartitions: Set[TopicPartition]) extends Subscription

Attributes

Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
final case class Pattern(pattern: Regex) extends Subscription

Attributes

Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
final case class Topics(topics: Set[String]) extends Subscription

Attributes

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

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror

Value members

Concrete methods

def manual(topicPartitions: (String, Int)*): Manual

Create a manual subscription to a fixed set of topic-partitions

Create a manual subscription to a fixed set of topic-partitions

A consumer with this type of subscription does not perform consumer rebalancing

Attributes

topicPartitions

Tuples of topic and partition

def manual(topic: String, partition: Int): Manual

Create a subscription to a single topic-partition

Create a subscription to a single topic-partition

A consumer with this type of subscription does not perform consumer rebalancing

Attributes

def pattern(pattern: Regex): Subscription

Create a subscription for all topics matching the given pattern

Create a subscription for all topics matching the given pattern

Attributes

pattern

Pattern

def pattern(pattern: String): Task[Subscription]

Create a subscription for all topics matching the given pattern

Create a subscription for all topics matching the given pattern

Attributes

pattern

Pattern to be converted to a Regex

Returns:

The created subscription or failure when the pattern is invalid

def pattern(pattern: Pattern): Subscription

Create a subscription for all topics matching the given pattern

Create a subscription for all topics matching the given pattern

Attributes

pattern

Pattern

def topics(name: String, names: String*): Subscription

Create a subscription for one or more topics

Create a subscription for one or more topics

Attributes

name

Topic to subscribe to

names

Additional topics to subscribe to

Generated with