io.github.resilience4j.ratelimiter

Class RateLimiterRegistry.Builder

java.lang.Object

io.github.resilience4j.ratelimiter.RateLimiterRegistry.Builder

Enclosing interface:

RateLimiterRegistry

public static class RateLimiterRegistry.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
RateLimiterRegistry.Builder	addRateLimiterConfig(java.lang.String configName, RateLimiterConfig configuration) Configures a RateLimiterRegistry with a custom RateLimiter configuration.
RateLimiterRegistry.Builder	addRegistryEventConsumer(io.github.resilience4j.core.registry.RegistryEventConsumer<RateLimiter> registryEventConsumer) Configures a RateLimiterRegistry with a RateLimiter registry event consumer.
RateLimiterRegistry	build() Builds a RateLimiterRegistry
RateLimiterRegistry.Builder	withRateLimiterConfig(RateLimiterConfig rateLimiterConfig) Configures a RateLimiterRegistry with a custom default RateLimiter configuration.
RateLimiterRegistry.Builder	withRegistryStore(io.github.resilience4j.core.RegistryStore registryStore)
RateLimiterRegistry.Builder	withTags(io.vavr.collection.Map<java.lang.String,java.lang.String> tags) Configures a RateLimiterRegistry with Tags.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

withRegistryStore

public RateLimiterRegistry.Builder withRegistryStore(io.github.resilience4j.core.RegistryStore registryStore)

withRateLimiterConfig

public RateLimiterRegistry.Builder withRateLimiterConfig(RateLimiterConfig rateLimiterConfig)

Configures a RateLimiterRegistry with a custom default RateLimiter configuration.

Parameters:

rateLimiterConfig - a custom default RateLimiter configuration

Returns:

a RateLimiterRegistry.Builder

addRateLimiterConfig

public RateLimiterRegistry.Builder addRateLimiterConfig(java.lang.String configName,
                                                        RateLimiterConfig configuration)

Configures a RateLimiterRegistry with a custom RateLimiter configuration.

Parameters:

configName - configName for a custom shared RateLimiter configuration

configuration - a custom shared RateLimiter configuration

Returns:

a RateLimiterRegistry.Builder

Throws:

java.lang.IllegalArgumentException - if configName.equals("default")

addRegistryEventConsumer

public RateLimiterRegistry.Builder addRegistryEventConsumer(io.github.resilience4j.core.registry.RegistryEventConsumer<RateLimiter> registryEventConsumer)

Configures a RateLimiterRegistry with a RateLimiter registry event consumer.

Parameters:

registryEventConsumer - a RateLimiter registry event consumer.

Returns:

a RateLimiterRegistry.Builder

withTags

public RateLimiterRegistry.Builder withTags(io.vavr.collection.Map<java.lang.String,java.lang.String> tags)

Configures a RateLimiterRegistry with Tags.

Tags added to the registry will be added to every instance created by this registry.

Parameters:

tags - default tags to add to the registry.

Returns:

a RateLimiterRegistry.Builder

build

public RateLimiterRegistry build()

Builds a RateLimiterRegistry

Returns:

the RateLimiterRegistry