runtime-core/aws.smithy.kotlin.runtime.retries.delay/AdaptiveRateLimiter/Config

Config

class Config(builder: AdaptiveRateLimiter.Config.Builder) : RateLimiter.Config

The configuration for an adaptive client-side rate limiter

Constructors

Config

constructor(builder: AdaptiveRateLimiter.Config.Builder)

Types

Builder

class Builder : RateLimiter.Config.Builder

Companion

object Companion

Properties

beta

val beta: Double

How much to scale back after receiving a throttling response. Ranges from 0.0 (do not scale back) to 1.0 (scale back completely). Defaults to 0.7 (scale back 70%).

measurementBucketDuration

val measurementBucketDuration: <Error class: unknown class>

The duration of individual measurement buckets used in measuring the effective transaction rate. Defaults to 0.5 seconds.

minCapacity

val minCapacity: Double

The minimum capacity of permits. Defaults to 1.

minFillRate

val minFillRate: Double

The minimum refill rate (per second) of permits. Defaults to 0.5.

scaleConstant

val scaleConstant: Double

How much to scale up after receiving a successful response. Ranges from 0.0 (do not scale up) to 1.0 (scale up completely). Defaults to 0.4 (scale up 40%).

smoothing

val smoothing: Double

The exponential smoothing factor to apply when measuring the effective rate of transactions. Ranges from 0.0 (do not accept new rate updates) to 1.0 (immediately accept new rates with no smoothing). Defaults to 0.8 (new rates are factored into the measured rate at 80%).

Functions

toBuilderApplicator

open override fun toBuilderApplicator(): RateLimiter.Config.Builder.() -> Unit