Packages

final case class ConsumerSettings(properties: Map[String, AnyRef] = Map.empty, closeTimeout: zio.Duration = 30.seconds, pollTimeout: zio.Duration = 50.millis, commitTimeout: zio.Duration = ConsumerSettings.defaultCommitTimeout, offsetRetrieval: OffsetRetrieval = OffsetRetrieval.Auto(), rebalanceListener: RebalanceListener = RebalanceListener.noop, restartStreamOnRebalancing: Boolean = false, runloopTimeout: zio.Duration = ConsumerSettings.defaultRunloopTimeout, fetchStrategy: FetchStrategy = QueueSizeBasedFetchStrategy()) extends Product with Serializable

Settings for the consumer.

To stay source compatible with future releases, you are recommended to construct the settings as follows:

ConsumerSettings(bootstrapServers)
  .withGroupId(groupId)
  .withProperties(properties)
  .... etc.
Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConsumerSettings
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ConsumerSettings(properties: Map[String, AnyRef] = Map.empty, closeTimeout: zio.Duration = 30.seconds, pollTimeout: zio.Duration = 50.millis, commitTimeout: zio.Duration = ConsumerSettings.defaultCommitTimeout, offsetRetrieval: OffsetRetrieval = OffsetRetrieval.Auto(), rebalanceListener: RebalanceListener = RebalanceListener.noop, restartStreamOnRebalancing: Boolean = false, runloopTimeout: zio.Duration = ConsumerSettings.defaultRunloopTimeout, fetchStrategy: FetchStrategy = QueueSizeBasedFetchStrategy())

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]) @IntrinsicCandidate() @native()
  6. val closeTimeout: zio.Duration
  7. val commitTimeout: zio.Duration
  8. def driverSettings: Map[String, AnyRef]
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. val fetchStrategy: FetchStrategy
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  16. val offsetRetrieval: OffsetRetrieval
  17. val pollTimeout: zio.Duration
  18. def productElementNames: Iterator[String]
    Definition Classes
    Product
  19. val properties: Map[String, AnyRef]
  20. val rebalanceListener: RebalanceListener
  21. val restartStreamOnRebalancing: Boolean
  22. val runloopTimeout: zio.Duration
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. def withBootstrapServers(servers: List[String]): ConsumerSettings
  28. def withClientId(clientId: String): ConsumerSettings
  29. def withCloseTimeout(timeout: zio.Duration): ConsumerSettings
  30. def withCommitTimeout(timeout: zio.Duration): ConsumerSettings
  31. def withCredentials(credentialsStore: KafkaCredentialStore): ConsumerSettings
  32. def withFetchStrategy(fetchStrategy: FetchStrategy): ConsumerSettings

    WARNING: zio.kafka.consumer.fetch.FetchStrategy is an EXPERIMENTAL API and may change in an incompatible way without notice in any zio-kafka version.

    WARNING: zio.kafka.consumer.fetch.FetchStrategy is an EXPERIMENTAL API and may change in an incompatible way without notice in any zio-kafka version.

    fetchStrategy

    The fetch strategy which selects which partitions can fetch data in the next poll. The default is to use the zio.kafka.consumer.fetch.QueueSizeBasedFetchStrategy with a maxPartitionQueueSize parameter of 1024, which is calculated by taking 2 * the default max.poll.records of 500, rounded to the nearest power of 2.

  33. def withGroupId(groupId: String): ConsumerSettings
  34. def withGroupInstanceId(groupInstanceId: String): ConsumerSettings
  35. def withMaxPartitionQueueSize(maxPartitionQueueSize: Int): ConsumerSettings

    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 1024, calculated by taking 2 * the default max.poll.records of 500, rounded to the nearest power of 2.

  36. def withOffsetRetrieval(retrieval: OffsetRetrieval): ConsumerSettings
  37. def withPollTimeout(timeout: zio.Duration): ConsumerSettings

    The maximum time to block while polling the Kafka consumer.

    The maximum time to block while polling the Kafka consumer. The Kafka consumer will return earlier when the maximum number of record to poll (see https://kafka.apache.org/documentation/#consumerconfigs_max.poll.records) is collected.

    The default is 50ms which to good for low latency applications. Set this higher, e.g. 500ms for better throughput.

  38. def withProperties(kvs: Map[String, AnyRef]): ConsumerSettings
  39. def withProperties(kvs: (String, AnyRef)*): ConsumerSettings
  40. def withProperty(key: String, value: AnyRef): ConsumerSettings
  41. def withRebalanceListener(listener: RebalanceListener): ConsumerSettings
  42. def withRestartStreamOnRebalancing(value: Boolean): ConsumerSettings

    value

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

  43. def withRunloopTimeout(timeout: zio.Duration): ConsumerSettings

    timeout

    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.

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped