Class Bucket4jRateLimiter.Config

java.lang.Object

org.springframework.cloud.gateway.filter.ratelimit.Bucket4jRateLimiter.Config

Enclosing class:

Bucket4jRateLimiter

public static class Bucket4jRateLimiter.Config
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected @Nullable Supplier<CompletableFuture<io.github.bucket4j.BucketConfiguration>>	configurationSupplier
protected @Nullable Duration	refillPeriod
protected @Nullable Long	refillTokens
protected @Nullable Instant	timeOfFirstRefill

Constructor Summary

Constructors

Constructor	Description
Config()

Method Summary

Modifier and Type	Method	Description
long	getCapacity()
Function<Bucket4jRateLimiter.Config, io.github.bucket4j.BucketConfiguration>	getConfigurationBuilder()
Supplier<CompletableFuture<io.github.bucket4j.BucketConfiguration>>	getConfigurationSupplier()
String	getHeaderName()
@Nullable Duration	getRefillPeriod()
Bucket4jRateLimiter.RefillStyle	getRefillStyle()
@Nullable Long	getRefillTokens()
long	getRequestedTokens()
@Nullable Instant	getTimeOfFirstRefill()
Bucket4jRateLimiter.Config	setCapacity(long capacity)
void	setConfigurationBuilder(Function<Bucket4jRateLimiter.Config, io.github.bucket4j.BucketConfiguration> configurationBuilder)
void	setConfigurationSupplier(Function<Bucket4jRateLimiter.Config, io.github.bucket4j.BucketConfiguration> configurationBuilder)
Bucket4jRateLimiter.Config	setHeaderName(String headerName)
Bucket4jRateLimiter.Config	setRefillPeriod(Duration refillPeriod)
Bucket4jRateLimiter.Config	setRefillStyle(Bucket4jRateLimiter.RefillStyle refillStyle)
Bucket4jRateLimiter.Config	setRefillTokens(Long refillTokens)
Bucket4jRateLimiter.Config	setRequestedTokens(long requestedTokens)
Bucket4jRateLimiter.Config	setTimeOfFirstRefill(Instant timeOfFirstRefill)
String	toString()

Methods inherited from class Object

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

Field Details

configurationSupplier

protected @Nullable Supplier<CompletableFuture<io.github.bucket4j.BucketConfiguration>> configurationSupplier

refillPeriod

protected @Nullable Duration refillPeriod

refillTokens

protected @Nullable Long refillTokens

timeOfFirstRefill

protected @Nullable Instant timeOfFirstRefill

Constructor Details

Config

public Config()

Method Details

getCapacity

public long getCapacity()

setCapacity

public Bucket4jRateLimiter.Config setCapacity(long capacity)

getConfigurationBuilder

public Function<Bucket4jRateLimiter.Config, io.github.bucket4j.BucketConfiguration> getConfigurationBuilder()

setConfigurationBuilder

public void setConfigurationBuilder(Function<Bucket4jRateLimiter.Config, io.github.bucket4j.BucketConfiguration> configurationBuilder)

getConfigurationSupplier

public Supplier<CompletableFuture<io.github.bucket4j.BucketConfiguration>> getConfigurationSupplier()

setConfigurationSupplier

public void setConfigurationSupplier(Function<Bucket4jRateLimiter.Config, io.github.bucket4j.BucketConfiguration> configurationBuilder)

getHeaderName

public String getHeaderName()

setHeaderName

public Bucket4jRateLimiter.Config setHeaderName(String headerName)

getRefillPeriod

public @Nullable Duration getRefillPeriod()

setRefillPeriod

public Bucket4jRateLimiter.Config setRefillPeriod(Duration refillPeriod)

getRefillStyle

public Bucket4jRateLimiter.RefillStyle getRefillStyle()

setRefillStyle

public Bucket4jRateLimiter.Config setRefillStyle(Bucket4jRateLimiter.RefillStyle refillStyle)

getRefillTokens

public @Nullable Long getRefillTokens()

setRefillTokens

public Bucket4jRateLimiter.Config setRefillTokens(Long refillTokens)

getRequestedTokens

public long getRequestedTokens()

setRequestedTokens

public Bucket4jRateLimiter.Config setRequestedTokens(long requestedTokens)

getTimeOfFirstRefill

public @Nullable Instant getTimeOfFirstRefill()

setTimeOfFirstRefill

public Bucket4jRateLimiter.Config setTimeOfFirstRefill(Instant timeOfFirstRefill)

toString

public String toString()

Overrides:

toString in class Object