io.github.resilience4j.ratelimiter.annotation

Annotation Type RateLimiter

@Retention(value=RUNTIME)
 @Target(value={METHOD,TYPE})
 @Documented
public @interface RateLimiter

This annotation can be applied to a class or a specific method. Applying it on a class is equivalent to applying it on all its public methods. The annotation enables throttling for all methods where it is applied. Throttling monitoring is performed via a rate limiter. See RateLimiter for details. If using Spring, fallbackMethod can be resolved using Spring Expression Language (SpEL).

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	name Name of the rate limiter

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	fallbackMethod fallbackMethod method name.

Element Detail

name

public abstract java.lang.String name

Name of the rate limiter

Returns:

the name of the limiter

fallbackMethod

public abstract java.lang.String fallbackMethod

fallbackMethod method name.

Returns:

fallbackMethod method name.

Default:

""