Package com.linecorp.armeria.server.throttling.bucket4j

Class TokenBucketBuilder

java.lang.Object

com.linecorp.armeria.server.throttling.bucket4j.TokenBucketBuilder

@UnstableApi
public final class TokenBucketBuilder
extends Object

Builds a TokenBucket instance.

Method Summary

Modifier and Type	Method	Description
TokenBucket	build()	Returns a newly-created TokenBucket based on the set of limits configured for this builder.
TokenBucketBuilder	limit(long limit, long overdraftLimit, long initialSize, Duration period)	Adds new BandwidthLimit.
TokenBucketBuilder	limit(long limit, long overdraftLimit, Duration period)	Adds new BandwidthLimit.
TokenBucketBuilder	limit(long limit, Duration period)	Adds new BandwidthLimit.
TokenBucketBuilder	limits(BandwidthLimit... limits)	Adds a number of BandwidthLimit.
TokenBucketBuilder	limits(Iterable<BandwidthLimit> limits)	Adds a number of BandwidthLimit.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

limits

public TokenBucketBuilder limits(BandwidthLimit... limits)

Adds a number of BandwidthLimit.

limits

public TokenBucketBuilder limits(Iterable<BandwidthLimit> limits)

Adds a number of BandwidthLimit.

limit

public TokenBucketBuilder limit(long limit,
 long overdraftLimit,
 long initialSize,
 Duration period)

Adds new BandwidthLimit.

limit

public TokenBucketBuilder limit(long limit,
 long overdraftLimit,
 Duration period)

Adds new BandwidthLimit.

limit

public TokenBucketBuilder limit(long limit,
 Duration period)

Adds new BandwidthLimit.

build

public TokenBucket build()

Returns a newly-created TokenBucket based on the set of limits configured for this builder.