io.micronaut.ratelimiter.resilience4j

Class RateLimiterConfiguration

java.lang.Object

io.micronaut.ratelimiter.resilience4j.RateLimiterConfiguration

@EachProperty(value="resilience4j.ratelimiter.configurations",
              primary="default")
public class RateLimiterConfiguration
extends java.lang.Object

Configuration for pre-defined rate limiters.

Since:

1.0.0

Author:

James Kleeh

Constructor Summary

Constructors

Constructor and Description
RateLimiterConfiguration(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
java.util.Optional<java.lang.Long>	getLimit()
java.lang.String	getName()
java.util.Optional<java.time.Duration>	getPeriod()
java.util.Optional<java.time.Duration>	getTimeout()
void	setLimit(java.lang.Long limit)
void	setPeriod(java.time.Duration period)
void	setTimeout(java.time.Duration timeout)

Methods inherited from class java.lang.Object

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

Constructor Detail

RateLimiterConfiguration

public RateLimiterConfiguration(@Parameter
                                java.lang.String name)

Parameters:

name - The name of the configuration

Method Detail

getName

@Nonnull
public java.lang.String getName()

Returns:

The name of the configuration

getPeriod

@Nonnull
public java.util.Optional<java.time.Duration> getPeriod()

Returns:

The optional rate limit duration

setPeriod

public void setPeriod(java.time.Duration period)

Parameters:

period - The refresh period of the rate limit

getLimit

@Nonnull
public java.util.Optional<java.lang.Long> getLimit()

Returns:

The optional request count limit

setLimit

public void setLimit(java.lang.Long limit)

Parameters:

limit - How many requests are allowed in the period

getTimeout

@Nonnull
public java.util.Optional<java.time.Duration> getTimeout()

Returns:

The timeout to retrieve rate limit permission

setTimeout

public void setTimeout(java.time.Duration timeout)

Parameters:

timeout - How long to wait for rate limit permission