Package io.github.resilience4j.ratelimiter

Class RateLimiterConfig

java.lang.Object

io.github.resilience4j.ratelimiter.RateLimiterConfig

All Implemented Interfaces:

Serializable

public class RateLimiterConfig
extends Object
implements Serializable

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RateLimiterConfig.Builder

Method Summary

Modifier and Type	Method	Description
static RateLimiterConfig.Builder	custom()	Returns a builder to create a custom RateLimiterConfig.
static RateLimiterConfig.Builder	from(RateLimiterConfig prototype)	Returns a builder to create a custom RateLimiterConfig using specified config as prototype
Predicate<io.github.resilience4j.core.functions.Either<? extends Throwable,?>>	getDrainPermissionsOnResult()
int	getLimitForPeriod()
Duration	getLimitRefreshPeriod()
Duration	getTimeoutDuration()
boolean	isWritableStackTraceEnabled()
static RateLimiterConfig	ofDefaults()	Creates a default RateLimiter configuration.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

custom

public static RateLimiterConfig.Builder custom()

Returns a builder to create a custom RateLimiterConfig.

Returns:

a RateLimiterConfig.Builder

from

public static RateLimiterConfig.Builder from(RateLimiterConfig prototype)

Returns a builder to create a custom RateLimiterConfig using specified config as prototype

Parameters:

prototype - A RateLimiterConfig prototype.

Returns:

a RateLimiterConfig.Builder

ofDefaults

public static RateLimiterConfig ofDefaults()

Creates a default RateLimiter configuration.

Returns:

a default RateLimiter configuration.

getTimeoutDuration

public Duration getTimeoutDuration()

getLimitRefreshPeriod

public Duration getLimitRefreshPeriod()

getLimitForPeriod

public int getLimitForPeriod()

getDrainPermissionsOnResult

public Predicate<io.github.resilience4j.core.functions.Either<? extends Throwable,?>> getDrainPermissionsOnResult()

isWritableStackTraceEnabled

public boolean isWritableStackTraceEnabled()

toString

public String toString()

Overrides:

toString in class Object