fs2.kafka.consumer.KafkaTopicsV2.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fs2-kafka_2.12 Show documentation
fs2-kafka
The newest version!
/*
 * Copyright 2018-2024 OVO Energy Limited
 *
 * SPDX-License-Identifier: Apache-2.0
 */

package fs2.kafka.consumer

import scala.concurrent.duration.FiniteDuration

import org.apache.kafka.clients.consumer.OffsetAndTimestamp
import org.apache.kafka.common.{PartitionInfo, TopicPartition}

trait KafkaTopicsV2[F[_]] extends KafkaTopics[F] {

  /**
    * Get metadata about partitions for all topics that the user is authorized to view. This method
    * will issue a remote call to the server.


    *
    * Timeout is determined by `default.api.timeout.ms`, which is set using
    * [[ConsumerSettings#withDefaultApiTimeout]].
    */
  def listTopics: F[Map[String, List[PartitionInfo]]]

  /**
    * Get metadata about partitions for all topics that the user is authorized to view. This method
    * will issue a remote call to the server.


    */
  def listTopics(timeout: FiniteDuration): F[Map[String, List[PartitionInfo]]]

  /**
    * 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.


    *
    * Timeout is determined by `default.api.timeout.ms`, which is set using
    * [[ConsumerSettings#withDefaultApiTimeout]].
    */
  def offsetsForTimes(
    timestampsToSearch: Map[TopicPartition, Long]
  ): F[Map[TopicPartition, Option[OffsetAndTimestamp]]]

  /**
    * 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.
    */
  def offsetsForTimes(
    timestampsToSearch: Map[TopicPartition, Long],
    timeout: FiniteDuration
  ): F[Map[TopicPartition, Option[OffsetAndTimestamp]]]

}