io.github.resilience4j.ratelimiter.configure

Class RateLimiterConfigurationProperties.LimiterProperties

java.lang.Object

io.github.resilience4j.ratelimiter.configure.RateLimiterConfigurationProperties.LimiterProperties

Enclosing class:

RateLimiterConfigurationProperties

public static class RateLimiterConfigurationProperties.LimiterProperties
extends java.lang.Object

Class storing property values for configuring RateLimiterConfig instances.

Constructor Summary

Constructors

Constructor and Description
LimiterProperties()

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	getEventConsumerBufferSize()
java.lang.Integer	getLimitForPeriod() Configures the permissions limit for refresh period.
java.lang.Integer	getLimitRefreshPeriodInMillis() Configures the period of limit refresh.
java.lang.Boolean	getRegisterHealthIndicator()
java.lang.Boolean	getSubscribeForEvents()
java.lang.Integer	getTimeoutInMillis() Configures the default wait for permission duration.
void	setEventConsumerBufferSize(java.lang.Integer eventConsumerBufferSize)
void	setLimitForPeriod(java.lang.Integer limitForPeriod) Configures the permissions limit for refresh period.
void	setLimitRefreshPeriodInMillis(java.lang.Integer limitRefreshPeriodInMillis) Configures the period of limit refresh.
void	setRegisterHealthIndicator(java.lang.Boolean registerHealthIndicator)
void	setSubscribeForEvents(java.lang.Boolean subscribeForEvents)
void	setTimeoutInMillis(java.lang.Integer timeoutInMillis) Configures the default wait for permission duration.

Methods inherited from class java.lang.Object

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

Constructor Detail

LimiterProperties

public LimiterProperties()

Method Detail

getLimitForPeriod

public java.lang.Integer getLimitForPeriod()

Configures the permissions limit for refresh period. Count of permissions available during one rate limiter period specified by RateLimiterConfig.limitRefreshPeriod value. Default value is 50.

Returns:

the permissions limit for refresh period

setLimitForPeriod

public void setLimitForPeriod(java.lang.Integer limitForPeriod)

Configures the permissions limit for refresh period. Count of permissions available during one rate limiter period specified by RateLimiterConfig.limitRefreshPeriod value. Default value is 50.

Parameters:

limitForPeriod - the permissions limit for refresh period

getLimitRefreshPeriodInMillis

public java.lang.Integer getLimitRefreshPeriodInMillis()

Configures the period of limit refresh. After each period rate limiter sets its permissions count to RateLimiterConfig.limitForPeriod value. Default value is 500 nanoseconds.

Returns:

the period of limit refresh

setLimitRefreshPeriodInMillis

public void setLimitRefreshPeriodInMillis(java.lang.Integer limitRefreshPeriodInMillis)

Configures the period of limit refresh. After each period rate limiter sets its permissions count to RateLimiterConfig.limitForPeriod value. Default value is 500 nanoseconds.

Parameters:

limitRefreshPeriodInMillis - the period of limit refresh

getTimeoutInMillis

public java.lang.Integer getTimeoutInMillis()

Configures the default wait for permission duration. Default value is 5 seconds.

Returns:

wait for permission duration

setTimeoutInMillis

public void setTimeoutInMillis(java.lang.Integer timeoutInMillis)

Configures the default wait for permission duration. Default value is 5 seconds.

Parameters:

timeoutInMillis - wait for permission duration

getSubscribeForEvents

public java.lang.Boolean getSubscribeForEvents()

setSubscribeForEvents

public void setSubscribeForEvents(java.lang.Boolean subscribeForEvents)

getEventConsumerBufferSize

public java.lang.Integer getEventConsumerBufferSize()

setEventConsumerBufferSize

public void setEventConsumerBufferSize(java.lang.Integer eventConsumerBufferSize)

getRegisterHealthIndicator

public java.lang.Boolean getRegisterHealthIndicator()

setRegisterHealthIndicator

public void setRegisterHealthIndicator(java.lang.Boolean registerHealthIndicator)