RateLimiterConfig (resilience4j-ratelimiter 1.7.1 API)

java.lang.Object

io.github.resilience4j.ratelimiter.RateLimiterConfig

All Implemented Interfaces:: java.io.Serializable

public class RateLimiterConfig
extends java.lang.Object
implements java.io.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
`java.util.function.Predicate<io.vavr.control.Either<? extends java.lang.Throwable,?>>`	`getDrainPermissionsOnResult()`
`int`	`getLimitForPeriod()`
`java.time.Duration`	`getLimitRefreshPeriod()`
`java.time.Duration`	`getTimeoutDuration()`
`boolean`	`isWritableStackTraceEnabled()`
`static RateLimiterConfig`	`ofDefaults()`	Creates a default RateLimiter configuration.
`java.lang.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 java.time.Duration getTimeoutDuration()
- getLimitRefreshPeriod
  
  public java.time.Duration getLimitRefreshPeriod()
- getLimitForPeriod
  
  public int getLimitForPeriod()
- getDrainPermissionsOnResult
  
  public java.util.function.Predicate<io.vavr.control.Either<? extends java.lang.Throwable,?>> getDrainPermissionsOnResult()
- isWritableStackTraceEnabled
  
  public boolean isWritableStackTraceEnabled()
- toString
  
  public java.lang.String toString()
  
  Overrides:
  
  toString in class java.lang.Object