Packages

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

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.

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.

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(bootstrapServers: List[String], properties: Map[String, AnyRef] = Map.empty, closeTimeout: zio.Duration = 30.seconds, pollTimeout: zio.Duration = 50.millis, offsetRetrieval: OffsetRetrieval = OffsetRetrieval.Auto(), rebalanceListener: RebalanceListener = RebalanceListener.noop, restartStreamOnRebalancing: Boolean = false, runloopTimeout: zio.Duration = ConsumerSettings.defaultRunloopTimeout, maxPartitionQueueSize: Int = 1024)

    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.

    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.

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. val bootstrapServers: List[String]
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. val closeTimeout: zio.Duration
  8. def driverSettings: Map[String, AnyRef]
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. val maxPartitionQueueSize: Int
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. val offsetRetrieval: OffsetRetrieval
  18. val pollTimeout: zio.Duration
  19. def productElementNames: Iterator[String]
    Definition Classes
    Product
  20. val properties: Map[String, AnyRef]
  21. val rebalanceListener: RebalanceListener
  22. val restartStreamOnRebalancing: Boolean
  23. val runloopTimeout: zio.Duration
  24. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  28. def withBootstrapServers(servers: List[String]): ConsumerSettings
  29. def withClientId(clientId: String): ConsumerSettings
  30. def withCloseTimeout(timeout: zio.Duration): ConsumerSettings
  31. def withCredentials(credentialsStore: KafkaCredentialStore): ConsumerSettings
  32. def withGroupId(groupId: String): ConsumerSettings
  33. def withGroupInstanceId(groupInstanceId: String): ConsumerSettings
  34. def withMaxPartitionQueueSize(maxPartitionQueueSize: Int): ConsumerSettings
  35. def withOffsetRetrieval(retrieval: OffsetRetrieval): ConsumerSettings
  36. def withPollTimeout(timeout: zio.Duration): ConsumerSettings
  37. def withProperties(kvs: Map[String, AnyRef]): ConsumerSettings
  38. def withProperties(kvs: (String, AnyRef)*): ConsumerSettings
  39. def withProperty(key: String, value: AnyRef): ConsumerSettings
  40. def withRebalanceListener(listener: RebalanceListener): ConsumerSettings
  41. def withRestartStreamOnRebalancing(value: Boolean): ConsumerSettings
  42. def withRunloopTimeout(timeout: zio.Duration): ConsumerSettings

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped