wisp-rate-limiting/wisp.ratelimiting/RateLimitConfiguration

RateLimitConfiguration

interface RateLimitConfiguration

The rate limit configuration applied to a rate limit bucket

Properties

Link copied to clipboard
abstract val capacity: Long

The maximum number of tokens that can accumulate in the bucket

Link copied to clipboard
abstract val name: String

A name identifying the configuration, e.g. "OriginationFileProcessing" for a rate limit configuration governing the rate at which origination files can be processed

Link copied to clipboard
abstract val refillAmount: Long

The amount of tokens added back to the limit bucket every refillPeriod

Link copied to clipboard
abstract val refillPeriod: Duration

The period of time over which refillAmount tokens are added back to the bucket

Link copied to clipboard
Link copied to clipboard
open val version: Long?

The version of the configuration. This allows implicit configuration replacement. Make sure to increase the version when changing the configuration. Desired version should start from 1