zio-kafka
API
Generated with
zio-kafka/zio.kafka/zio.kafka.consumer

zio.kafka.consumer

package zio.kafka.consumer

Members list

Packages

package zio.kafka.consumer.diagnostics
package zio.kafka.consumer.internal

Type members

Classlikes

final case class CommittableRecord[K, V](record: ConsumerRecord[K, V], commitHandle: Map[TopicPartition, Long] => Task[Unit], consumerGroupMetadata: Option[ConsumerGroupMetadata])

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
trait Consumer

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object Consumer

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Consumer.type
final case class ConsumerSettings(bootstrapServers: List[String], properties: Map[String, AnyRef], closeTimeout: Duration, pollTimeout: Duration, offsetRetrieval: OffsetRetrieval, rebalanceListener: RebalanceListener, restartStreamOnRebalancing: Boolean, runloopTimeout: Duration, maxPartitionQueueSize: Int)

Value parameters

maxPartitionQueueSize

Maximum number of records to be buffered per partition. This buffer improves throughput and supports varying downstream message processing time, while maintaining some backpressure. Large values effectively disable backpressure at the cost of high memory usage, low values will effectively disable prefetching in favour of low memory consumption. The number of records that is fetched on every poll is controlled by the max.poll.records setting, the number of records fetched for every partition is somewhere between 0 and max.poll.records. A value that is a power of 2 offers somewhat better queueing performance. The default value for this parameter is 2 * the default max.poll.records of 500, rounded to the nearest power of 2.

restartStreamOnRebalancing

When true all streams are restarted during a rebalance, including those streams that are not revoked. The default is false.

runloopTimeout

Internal timeout for each iteration of the command processing and polling loop, use to detect stalling. This should be much larger than the pollTimeout and the time it takes to process chunks of records. If your consumer is not subscribed for long periods during its lifetime, this timeout should take that into account as well. When the timeout expires, the plainStream/partitionedStream/etc will fail with a Consumer.RunloopTimeout.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case object EmptyOffsetBatch extends OffsetBatch

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait OffsetBatch
class Object
trait Matchable
class Any
Show all
Self type
final case class InvalidSubscriptionUnion(subscriptions: Chunk[Subscription]) extends RuntimeException

Attributes

Supertypes
trait Product
trait Equals
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
sealed trait Offset

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object Offset

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Offset.type
sealed trait OffsetBatch

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object EmptyOffsetBatch.type
object OffsetBatch

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
trait RebalanceConsumer

A subset of Consumer methods available during rebalances.

A subset of Consumer methods available during rebalances.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Live
object RebalanceConsumer

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
final case class RebalanceListener(onAssigned: (Set[TopicPartition], RebalanceConsumer) => Task[Unit], onRevoked: (Set[TopicPartition], RebalanceConsumer) => Task[Unit], onLost: (Set[TopicPartition], RebalanceConsumer) => Task[Unit])

ZIO wrapper around Kafka's ConsumerRebalanceListener to work with Scala collection types and ZIO effects.

ZIO wrapper around Kafka's ConsumerRebalanceListener to work with Scala collection types and ZIO effects.

Attributes

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

Attributes

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

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Manual
class Pattern
class Topics
object Subscription

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Generated with