Packages

trait Consumer extends AnyRef

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Consumer
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def assignment: Task[Set[TopicPartition]]

    Returns the topic-partitions that this consumer is currently assigned.

    Returns the topic-partitions that this consumer is currently assigned.

    This is subject to consumer rebalancing, unless using a manual subscription.

  2. abstract def beginningOffsets(partitions: Set[TopicPartition], timeout: zio.Duration = Duration.Infinity): Task[Map[TopicPartition, Long]]
  3. abstract def committed(partitions: Set[TopicPartition], timeout: zio.Duration = Duration.Infinity): Task[Map[TopicPartition, Option[OffsetAndMetadata]]]

    Retrieve the last committed offset for the given topic-partitions

  4. abstract def consumeWith[R, R1, K, V](subscription: Subscription, keyDeserializer: Deserializer[R, K], valueDeserializer: Deserializer[R, V], commitRetryPolicy: Schedule[Any, Any, Any] = Schedule.exponential(1.second) && Schedule.recurs(3))(f: (ConsumerRecord[K, V]) => URIO[R1, Unit])(implicit arg0: zio.EnvironmentTag[R], arg1: zio.EnvironmentTag[R1]): ZIO[zio.&[R, R1], Throwable, Unit]

    See Consumer.consumeWith.

  5. abstract def endOffsets(partitions: Set[TopicPartition], timeout: zio.Duration = Duration.Infinity): Task[Map[TopicPartition, Long]]
  6. abstract def listTopics(timeout: zio.Duration = Duration.Infinity): Task[Map[String, List[PartitionInfo]]]
  7. abstract def metrics: Task[Map[MetricName, Metric]]

    Expose internal consumer metrics

  8. abstract def offsetsForTimes(timestamps: Map[TopicPartition, Long], timeout: zio.Duration = Duration.Infinity): Task[Map[TopicPartition, OffsetAndTimestamp]]

    Look up the offsets for the given partitions by timestamp.

    Look up the offsets for the given partitions by timestamp. The returned offset for each partition is the earliest offset whose timestamp is greater than or equal to the given timestamp in the corresponding partition.

    The consumer does not have to be assigned the partitions. If no messages exist yet for a partition, it will not exist in the returned map.

  9. abstract def partitionedAssignmentStream[R, K, V](subscription: Subscription, keyDeserializer: Deserializer[R, K], valueDeserializer: Deserializer[R, V]): Stream[Throwable, Chunk[(TopicPartition, ZStream[R, Throwable, CommittableRecord[K, V]])]]

    Create a stream that emits chunks whenever new partitions are assigned to this consumer.

    Create a stream that emits chunks whenever new partitions are assigned to this consumer.

    The top-level stream will emit chunks whenever the consumer rebalances, unless a manual subscription was made. When rebalancing occurs, new topic-partition streams may be emitted and existing streams may be completed.

    All streams can be completed by calling stopConsumption.

    Multiple subscriptions on one Consumer are supported, as long as the subscriptions are of the same type (topics, patterns, manual). Each subscription will only receive messages from the topic-partitions that match the subscription. When subscriptions overlap, kafka records will be divided over the overlapping subscriptions non-deterministically.

    On completion of the stream, the consumer is unsubscribed. In case of multiple subscriptions, the total consumer subscription is changed to exclude this subscription.

  10. abstract def partitionedStream[R, K, V](subscription: Subscription, keyDeserializer: Deserializer[R, K], valueDeserializer: Deserializer[R, V]): Stream[Throwable, (TopicPartition, ZStream[R, Throwable, CommittableRecord[K, V]])]

    Create a stream with messages on the subscribed topic-partitions by topic-partition

    Create a stream with messages on the subscribed topic-partitions by topic-partition

    The top-level stream will emit new topic-partition streams for each topic-partition that is assigned to this consumer. This is subject to consumer rebalancing, unless a manual subscription was made. When rebalancing occurs, new topic-partition streams may be emitted and existing streams may be completed.

    All streams can be completed by calling stopConsumption.

    Multiple subscriptions on one Consumer are supported, as long as the subscriptions are of the same type (topics, patterns, manual). Each subscription will only receive messages from the topic-partitions that match the subscription. When subscriptions overlap, kafka records will be divided over the overlapping subscriptions non-deterministically.

    On completion of the stream, the consumer is unsubscribed. In case of multiple subscriptions, the total consumer subscription is changed to exclude this subscription.

  11. abstract def partitionsFor(topic: String, timeout: zio.Duration = Duration.Infinity): Task[List[PartitionInfo]]
  12. abstract def plainStream[R, K, V](subscription: Subscription, keyDeserializer: Deserializer[R, K], valueDeserializer: Deserializer[R, V], bufferSize: Int = 4): ZStream[R, Throwable, CommittableRecord[K, V]]

    Create a stream with all messages on the subscribed topic-partitions

    Create a stream with all messages on the subscribed topic-partitions

    The stream will emit messages from all topic-partitions interleaved. Per-partition record order is guaranteed, but the topic-partition interleaving is non-deterministic.

    Up to bufferSize chunks may be buffered in memory by this operator.

    The stream can be completed by calling stopConsumption.

    Multiple subscriptions on one Consumer are supported, as long as the subscriptions are of the same type (topics, patterns, manual). Each subscription will only receive messages from the topic-partitions that match the subscription. When subscriptions overlap, kafka records will be divided over the overlapping subscriptions non-deterministically.

    On completion of the stream, the consumer is unsubscribed. In case of multiple subscriptions, the total consumer subscription is changed to exclude this subscription.

  13. abstract def position(partition: TopicPartition, timeout: zio.Duration = Duration.Infinity): Task[Long]
  14. abstract def stopConsumption: UIO[Unit]

    Stops consumption of data, drains buffered records, and ends the attached streams while still serving commit requests.

  15. abstract def subscription: Task[Set[String]]

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped