final case class ThrottlerConfig(class: String, maxQueueSize: Option[Int], maxConcurrentRequests: Option[Int], maxRequestsPerSecond: Option[Int], drainInterval: Option[Duration]) extends Product with Serializable

A session-wide component that controls the rate at which requests are executed.

class

The class of the throttler. If it is not qualified, the driver assumes that it resides in the package com.datastax.oss.driver.internal.core.session.throttling.

maxQueueSize

The maximum number of requests that can be enqueued when the throttling threshold is exceeded. Beyond that size, requests will fail with a RequestThrottlingException.

maxConcurrentRequests

The maximum number of requests that are allowed to execute in parallel. Only used by ConcurrencyLimitingRequestThrottler.

maxRequestsPerSecond

The maximum allowed request rate. Only used by RateLimitingRequestThrottler.

drainInterval

How often the throttler attempts to dequeue requests. Only used by RateLimitingRequestThrottler.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ThrottlerConfig
  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 ThrottlerConfig(class: String, maxQueueSize: Option[Int], maxConcurrentRequests: Option[Int], maxRequestsPerSecond: Option[Int], drainInterval: Option[Duration])

    class

    The class of the throttler. If it is not qualified, the driver assumes that it resides in the package com.datastax.oss.driver.internal.core.session.throttling.

    maxQueueSize

    The maximum number of requests that can be enqueued when the throttling threshold is exceeded. Beyond that size, requests will fail with a RequestThrottlingException.

    maxConcurrentRequests

    The maximum number of requests that are allowed to execute in parallel. Only used by ConcurrencyLimitingRequestThrottler.

    maxRequestsPerSecond

    The maximum allowed request rate. Only used by RateLimitingRequestThrottler.

    drainInterval

    How often the throttler attempts to dequeue requests. Only used by RateLimitingRequestThrottler.

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 class: String
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  7. val drainInterval: Option[Duration]
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. val maxConcurrentRequests: Option[Int]
  12. val maxQueueSize: Option[Int]
  13. val maxRequestsPerSecond: Option[Int]
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  17. def productElementNames: Iterator[String]
    Definition Classes
    Product
  18. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

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