Skip navigation links
A B C D E F G I M N O P R S T V W 

A

acquirePermission() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Try to obtain a permission to execute a call.
acquirePermission() - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
 
allowPublish - Variable in enum io.github.resilience4j.circuitbreaker.CircuitBreaker.State
 
automaticTransitionFromOpenToHalfOpenEnabled(boolean) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
Enables automatic transition from OPEN to HALF_OPEN state once the waitDurationInOpenState has passed.

B

BUFFERED - Static variable in class io.github.resilience4j.circuitbreaker.utils.MetricNames
 
build() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
Builds a CircuitBreakerConfig
Builder(CircuitBreakerConfig) - Constructor for class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
 
Builder() - Constructor for class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
 

C

CallNotPermittedException - Exception in io.github.resilience4j.circuitbreaker
A CallNotPermittedException signals that the CircuitBreaker is HALF_OPEN or OPEN and a call is not permitted to be executed.
cancel(boolean) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreaker.CircuitBreakerFuture
 
CircuitBreaker - Interface in io.github.resilience4j.circuitbreaker
A CircuitBreaker instance is thread-safe can be used to decorate multiple requests.
circuitBreaker(String) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry
Returns a managed CircuitBreaker or creates a new one with the default CircuitBreaker configuration.
circuitBreaker(String, Map<String, String>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry
Returns a managed CircuitBreaker or creates a new one with the default CircuitBreaker configuration.
circuitBreaker(String, CircuitBreakerConfig) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry
Returns a managed CircuitBreaker or creates a new one with a custom CircuitBreaker configuration.
circuitBreaker(String, CircuitBreakerConfig, Map<String, String>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry
Returns a managed CircuitBreaker or creates a new one with a custom CircuitBreaker configuration.
circuitBreaker(String, String) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry
Returns a managed CircuitBreaker or creates a new one with a custom CircuitBreaker configuration.
circuitBreaker(String, String, Map<String, String>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry
Returns a managed CircuitBreaker or creates a new one with a custom CircuitBreaker configuration.
circuitBreaker(String, Supplier<CircuitBreakerConfig>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry
Returns a managed CircuitBreaker or creates a new one with a custom CircuitBreaker configuration.
circuitBreaker(String, Supplier<CircuitBreakerConfig>, Map<String, String>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry
Returns a managed CircuitBreaker or creates a new one with a custom CircuitBreaker configuration.
circuitBreaker(String) - Method in class io.github.resilience4j.circuitbreaker.internal.InMemoryCircuitBreakerRegistry
Returns a managed CircuitBreaker or creates a new one with the default CircuitBreaker configuration.
circuitBreaker(String, Map<String, String>) - Method in class io.github.resilience4j.circuitbreaker.internal.InMemoryCircuitBreakerRegistry
 
circuitBreaker(String, CircuitBreakerConfig) - Method in class io.github.resilience4j.circuitbreaker.internal.InMemoryCircuitBreakerRegistry
Returns a managed CircuitBreaker or creates a new one with a custom CircuitBreaker configuration.
circuitBreaker(String, CircuitBreakerConfig, Map<String, String>) - Method in class io.github.resilience4j.circuitbreaker.internal.InMemoryCircuitBreakerRegistry
 
circuitBreaker(String, String) - Method in class io.github.resilience4j.circuitbreaker.internal.InMemoryCircuitBreakerRegistry
Returns a managed CircuitBreaker or creates a new one with a custom CircuitBreaker configuration.
circuitBreaker(String, String, Map<String, String>) - Method in class io.github.resilience4j.circuitbreaker.internal.InMemoryCircuitBreakerRegistry
 
circuitBreaker(String, Supplier<CircuitBreakerConfig>) - Method in class io.github.resilience4j.circuitbreaker.internal.InMemoryCircuitBreakerRegistry
Returns a managed CircuitBreaker or creates a new one with a custom CircuitBreaker configuration.
circuitBreaker(String, Supplier<CircuitBreakerConfig>, Map<String, String>) - Method in class io.github.resilience4j.circuitbreaker.internal.InMemoryCircuitBreakerRegistry
 
CircuitBreaker.CircuitBreakerFuture<T> - Class in io.github.resilience4j.circuitbreaker
This class decorates future to add CircuitBreaking functionality around invocation.
CircuitBreaker.EventPublisher - Interface in io.github.resilience4j.circuitbreaker
An EventPublisher can be used to register event consumers.
CircuitBreaker.Metrics - Interface in io.github.resilience4j.circuitbreaker
 
CircuitBreaker.State - Enum in io.github.resilience4j.circuitbreaker
States of the CircuitBreaker state machine.
CircuitBreaker.StateTransition - Enum in io.github.resilience4j.circuitbreaker
State transitions of the CircuitBreaker state machine.
CircuitBreakerConfig - Class in io.github.resilience4j.circuitbreaker
CircuitBreakerConfig.Builder - Class in io.github.resilience4j.circuitbreaker
 
CircuitBreakerConfig.SlidingWindowType - Enum in io.github.resilience4j.circuitbreaker
 
CircuitBreakerEvent - Interface in io.github.resilience4j.circuitbreaker.event
An event which is created by a CircuitBreaker.
CircuitBreakerEvent.Type - Enum in io.github.resilience4j.circuitbreaker.event
Event types which are created by a CircuitBreaker.
CircuitBreakerOnCallNotPermittedEvent - Class in io.github.resilience4j.circuitbreaker.event
A CircuitBreakerEvent which informs that a call was not permitted, because the CircuitBreaker is OPEN.
CircuitBreakerOnCallNotPermittedEvent(String) - Constructor for class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnCallNotPermittedEvent
 
CircuitBreakerOnErrorEvent - Class in io.github.resilience4j.circuitbreaker.event
A CircuitBreakerEvent which informs that an error has been recorded
CircuitBreakerOnErrorEvent(String, Duration, Throwable) - Constructor for class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnErrorEvent
 
CircuitBreakerOnIgnoredErrorEvent - Class in io.github.resilience4j.circuitbreaker.event
A CircuitBreakerEvent which informs that an error has been ignored
CircuitBreakerOnIgnoredErrorEvent(String, Duration, Throwable) - Constructor for class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnIgnoredErrorEvent
 
CircuitBreakerOnResetEvent - Class in io.github.resilience4j.circuitbreaker.event
A CircuitBreakerEvent which informs about a reset.
CircuitBreakerOnResetEvent(String) - Constructor for class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnResetEvent
 
CircuitBreakerOnStateTransitionEvent - Class in io.github.resilience4j.circuitbreaker.event
A CircuitBreakerEvent which informs about a state transition.
CircuitBreakerOnStateTransitionEvent(String, CircuitBreaker.StateTransition) - Constructor for class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnStateTransitionEvent
 
CircuitBreakerOnSuccessEvent - Class in io.github.resilience4j.circuitbreaker.event
A CircuitBreakerEvent which informs that a success has been recorded
CircuitBreakerOnSuccessEvent(String, Duration) - Constructor for class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnSuccessEvent
 
CircuitBreakerRegistry - Interface in io.github.resilience4j.circuitbreaker
The CircuitBreakerRegistry is a factory to create CircuitBreaker instances which stores all CircuitBreaker instances in a registry.
CircuitBreakerStateMachine - Class in io.github.resilience4j.circuitbreaker.internal
A CircuitBreaker finite state machine.
CircuitBreakerStateMachine(String, CircuitBreakerConfig, SchedulerFactory) - Constructor for class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
Creates a circuitBreaker.
CircuitBreakerStateMachine(String, CircuitBreakerConfig, Clock) - Constructor for class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
Creates a circuitBreaker.
CircuitBreakerStateMachine(String, CircuitBreakerConfig, Clock, Map<String, String>) - Constructor for class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
Creates a circuitBreaker.
CircuitBreakerStateMachine(String, CircuitBreakerConfig) - Constructor for class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
Creates a circuitBreaker.
CircuitBreakerStateMachine(String, CircuitBreakerConfig, Map<String, String>) - Constructor for class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
Creates a circuitBreaker.
CircuitBreakerStateMachine(String) - Constructor for class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
Creates a circuitBreaker with default config.
CircuitBreakerStateMachine(String, Supplier<CircuitBreakerConfig>) - Constructor for class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
Creates a circuitBreaker.
CircuitBreakerStateMachine(String, Supplier<CircuitBreakerConfig>, Map<String, String>) - Constructor for class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
Creates a circuitBreaker.
CircuitBreakerUtil - Class in io.github.resilience4j.circuitbreaker.utils
 
CircuitBreakerUtil() - Constructor for class io.github.resilience4j.circuitbreaker.utils.CircuitBreakerUtil
 
createCallNotPermittedException(CircuitBreaker) - Static method in exception io.github.resilience4j.circuitbreaker.CallNotPermittedException
Static method to construct a CallNotPermittedException with a CircuitBreaker.
custom() - Static method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
Returns a builder to create a custom CircuitBreakerConfig.

D

decorateCallable(CircuitBreaker, Callable<T>) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Returns a callable which is decorated by a CircuitBreaker.
decorateCallable(Callable<T>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Returns a callable which is decorated by a CircuitBreaker.
decorateCheckedConsumer(CircuitBreaker, CheckedConsumer<T>) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Returns a consumer which is decorated by a CircuitBreaker.
decorateCheckedConsumer(CheckedConsumer<T>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Returns a consumer which is decorated by a CircuitBreaker.
decorateCheckedFunction(CircuitBreaker, CheckedFunction1<T, R>) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Returns a function which is decorated by a CircuitBreaker.
decorateCheckedRunnable(CircuitBreaker, CheckedRunnable) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Returns a runnable which is decorated by a CircuitBreaker.
decorateCheckedRunnable(CheckedRunnable) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Returns a runnable which is decorated by a CircuitBreaker.
decorateCheckedSupplier(CircuitBreaker, CheckedFunction0<T>) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Returns a supplier which is decorated by a CircuitBreaker.
decorateCheckedSupplier(CheckedFunction0<T>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Returns a supplier which is decorated by a CircuitBreaker.
decorateCompletionStage(CircuitBreaker, Supplier<CompletionStage<T>>) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Returns a supplier which is decorated by a CircuitBreaker.
decorateCompletionStage(Supplier<CompletionStage<T>>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Returns a supplier which is decorated by a CircuitBreaker.
decorateConsumer(CircuitBreaker, Consumer<T>) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Returns a consumer which is decorated by a CircuitBreaker.
decorateConsumer(Consumer<T>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Returns a consumer which is decorated by a CircuitBreaker.
decorateEitherSupplier(CircuitBreaker, Supplier<Either<? extends Exception, T>>) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Returns a supplier which is decorated by a CircuitBreaker.
decorateEitherSupplier(Supplier<Either<? extends Exception, T>>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Returns a supplier which is decorated by a CircuitBreaker.
decorateFunction(CircuitBreaker, Function<T, R>) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Returns a function which is decorated by a CircuitBreaker.
decorateFuture(CircuitBreaker, Supplier<Future<T>>) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Returns a supplier of type Future which is decorated by a CircuitBreaker.
decorateFuture(Supplier<Future<T>>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Returns a supplier of type Future which is decorated by a CircuitBreaker.
decorateRunnable(CircuitBreaker, Runnable) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Returns a runnable which is decorated by a CircuitBreaker.
decorateRunnable(Runnable) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Returns a runnable which is decorated by a CircuitBreaker.
decorateSupplier(CircuitBreaker, Supplier<T>) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Returns a supplier which is decorated by a CircuitBreaker.
decorateSupplier(Supplier<T>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Returns a supplier which is decorated by a CircuitBreaker.
decorateTrySupplier(CircuitBreaker, Supplier<Try<T>>) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Returns a supplier which is decorated by a CircuitBreaker.
decorateTrySupplier(Supplier<Try<T>>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Returns a supplier which is decorated by a CircuitBreaker.
DEFAULT_FAILURE_RATE_THRESHOLD - Static variable in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
 
DEFAULT_MINIMUM_NUMBER_OF_CALLS - Static variable in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
 
DEFAULT_PERMITTED_CALLS_IN_HALF_OPEN_STATE - Static variable in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
 
DEFAULT_PREFIX - Static variable in class io.github.resilience4j.circuitbreaker.utils.MetricNames
 
DEFAULT_SLIDING_WINDOW_SIZE - Static variable in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
 
DEFAULT_SLIDING_WINDOW_TYPE - Static variable in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
 
DEFAULT_SLOW_CALL_DURATION_THRESHOLD - Static variable in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
 
DEFAULT_SLOW_CALL_RATE_THRESHOLD - Static variable in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
 
DEFAULT_WAIT_DURATION_IN_OPEN_STATE - Static variable in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
 
DEFAULT_WRITABLE_STACK_TRACE_ENABLED - Static variable in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
 

E

enableAutomaticTransitionFromOpenToHalfOpen() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
Enables automatic transition from OPEN to HALF_OPEN state once the waitDurationInOpenState has passed.
executeCallable(Callable<T>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Decorates and executes the decorated Callable.
executeCheckedRunnable(CheckedRunnable) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Decorates and executes the decorated Runnable.
executeCheckedSupplier(CheckedFunction0<T>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Decorates and executes the decorated Supplier.
executeCompletionStage(Supplier<CompletionStage<T>>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Decorates and executes the decorated CompletionStage.
executeEitherSupplier(Supplier<Either<? extends Exception, T>>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Decorates and executes the decorated Supplier.
executeRunnable(Runnable) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Decorates and executes the decorated Runnable.
executeSupplier(Supplier<T>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Decorates and executes the decorated Supplier.
executeTrySupplier(Supplier<Try<T>>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Decorates and executes the decorated Supplier.

F

FAILED - Static variable in class io.github.resilience4j.circuitbreaker.utils.MetricNames
 
FAILURE_RATE - Static variable in class io.github.resilience4j.circuitbreaker.utils.MetricNames
 
failureRateThreshold(float) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
Configures the failure rate threshold in percentage.
forcePublish - Variable in enum io.github.resilience4j.circuitbreaker.event.CircuitBreakerEvent.Type
 
from(CircuitBreakerConfig) - Static method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
Returns a builder to create a custom CircuitBreakerConfig based on another CircuitBreakerConfig.

G

get() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreaker.CircuitBreakerFuture
 
get(long, TimeUnit) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreaker.CircuitBreakerFuture
 
getAllCircuitBreakers() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry
Returns all managed CircuitBreaker instances.
getAllCircuitBreakers() - Method in class io.github.resilience4j.circuitbreaker.internal.InMemoryCircuitBreakerRegistry
Returns all managed CircuitBreaker instances.
getCircuitBreakerConfig() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Returns the CircuitBreakerConfig of this CircuitBreaker.
getCircuitBreakerConfig() - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
Get the config of this CircuitBreaker.
getCircuitBreakerName() - Method in interface io.github.resilience4j.circuitbreaker.event.CircuitBreakerEvent
Returns the name of the CircuitBreaker which has created the event.
getCreationTime() - Method in interface io.github.resilience4j.circuitbreaker.event.CircuitBreakerEvent
Returns the creation time of CircuitBreaker event.
getElapsedDuration() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnErrorEvent
 
getElapsedDuration() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnIgnoredErrorEvent
 
getElapsedDuration() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnSuccessEvent
 
getEventPublisher() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Returns an EventPublisher which can be used to register event consumers.
getEventPublisher() - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
 
getEventType() - Method in interface io.github.resilience4j.circuitbreaker.event.CircuitBreakerEvent
Returns the type of the CircuitBreaker event.
getEventType() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnCallNotPermittedEvent
 
getEventType() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnErrorEvent
 
getEventType() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnIgnoredErrorEvent
 
getEventType() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnResetEvent
 
getEventType() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnStateTransitionEvent
 
getEventType() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnSuccessEvent
 
getFailureRate() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics
Returns the current failure rate in percentage.
getFailureRateThreshold() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
 
getFromState() - Method in enum io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
 
getFromState() - Method in exception io.github.resilience4j.circuitbreaker.IllegalStateTransitionException
 
getIgnoreExceptionPredicate() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
 
getInstance() - Static method in class io.github.resilience4j.circuitbreaker.internal.SchedulerFactory
 
getMetrics() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Returns the Metrics of this CircuitBreaker.
getMetrics() - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
 
getMinimumNumberOfCalls() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
 
getName() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Returns the name of this CircuitBreaker.
getName() - Method in exception io.github.resilience4j.circuitbreaker.IllegalStateTransitionException
 
getName() - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
Get the name of this CircuitBreaker.
getNumberOfBufferedCalls() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics
Returns the current total number of buffered calls in the ring buffer.
getNumberOfFailedCalls() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics
Returns the current number of failed buffered calls in the ring buffer.
getNumberOfNotPermittedCalls() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics
Returns the current number of not permitted calls, when the state is OPEN.
getNumberOfSlowCalls() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics
Returns the current total number of calls which were slower than a certain threshold.
getNumberOfSlowFailedCalls() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics
Returns the current number of failed calls which were slower than a certain threshold.
getNumberOfSlowSuccessfulCalls() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics
Returns the current number of successful calls which were slower than a certain threshold.
getNumberOfSuccessfulCalls() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics
Returns the current number of successful buffered calls in the ring buffer.
getOrder() - Method in enum io.github.resilience4j.circuitbreaker.CircuitBreaker.State
 
getPermittedNumberOfCallsInHalfOpenState() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
 
getRecordExceptionPredicate() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
 
getScheduler() - Method in class io.github.resilience4j.circuitbreaker.internal.SchedulerFactory
 
getSlidingWindowSize() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
 
getSlidingWindowType() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
 
getSlowCallDurationThreshold() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
 
getSlowCallRate() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics
Returns the current percentage of calls which were slower than a certain threshold.
getSlowCallRateThreshold() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
 
getState() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Returns the state of this CircuitBreaker.
getState() - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
Get the state of this CircuitBreaker.
getStateTransition() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnStateTransitionEvent
 
getTags() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Returns an unmodifiable map with tags assigned to this Retry.
getTags() - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
 
getThrowable() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnErrorEvent
 
getThrowable() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnIgnoredErrorEvent
 
getToState() - Method in enum io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
 
getToState() - Method in exception io.github.resilience4j.circuitbreaker.IllegalStateTransitionException
 
getWaitDurationInOpenState() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
Deprecated.
getWaitIntervalFunctionInOpenState() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
Returns an interval function which controls how long the CircuitBreaker should stay open, before it switches to half open.

I

ignoreException(Predicate<Throwable>) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
Configures a Predicate which evaluates if an exception should be ignored and neither count as a failure nor success.
ignoreExceptions(Class<? extends Throwable>...) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
Configures a list of error classes that are ignored and thus neither count as a failure nor success.
IllegalStateTransitionException - Exception in io.github.resilience4j.circuitbreaker
A IllegalStateTransitionException signals that someone tried to trigger an illegal state transition..
InMemoryCircuitBreakerRegistry - Class in io.github.resilience4j.circuitbreaker.internal
Backend circuitBreaker manager.
InMemoryCircuitBreakerRegistry() - Constructor for class io.github.resilience4j.circuitbreaker.internal.InMemoryCircuitBreakerRegistry
The constructor with default default.
InMemoryCircuitBreakerRegistry(Map<String, String>) - Constructor for class io.github.resilience4j.circuitbreaker.internal.InMemoryCircuitBreakerRegistry
 
InMemoryCircuitBreakerRegistry(Map<String, CircuitBreakerConfig>) - Constructor for class io.github.resilience4j.circuitbreaker.internal.InMemoryCircuitBreakerRegistry
 
InMemoryCircuitBreakerRegistry(Map<String, CircuitBreakerConfig>, Map<String, String>) - Constructor for class io.github.resilience4j.circuitbreaker.internal.InMemoryCircuitBreakerRegistry
 
InMemoryCircuitBreakerRegistry(Map<String, CircuitBreakerConfig>, RegistryEventConsumer<CircuitBreaker>) - Constructor for class io.github.resilience4j.circuitbreaker.internal.InMemoryCircuitBreakerRegistry
 
InMemoryCircuitBreakerRegistry(Map<String, CircuitBreakerConfig>, List<RegistryEventConsumer<CircuitBreaker>>) - Constructor for class io.github.resilience4j.circuitbreaker.internal.InMemoryCircuitBreakerRegistry
 
InMemoryCircuitBreakerRegistry(CircuitBreakerConfig) - Constructor for class io.github.resilience4j.circuitbreaker.internal.InMemoryCircuitBreakerRegistry
The constructor with custom default config.
InMemoryCircuitBreakerRegistry(CircuitBreakerConfig, Map<String, String>) - Constructor for class io.github.resilience4j.circuitbreaker.internal.InMemoryCircuitBreakerRegistry
The constructor with custom default config.
InMemoryCircuitBreakerRegistry(CircuitBreakerConfig, RegistryEventConsumer<CircuitBreaker>) - Constructor for class io.github.resilience4j.circuitbreaker.internal.InMemoryCircuitBreakerRegistry
 
InMemoryCircuitBreakerRegistry(CircuitBreakerConfig, List<RegistryEventConsumer<CircuitBreaker>>) - Constructor for class io.github.resilience4j.circuitbreaker.internal.InMemoryCircuitBreakerRegistry
 
io.github.resilience4j.circuitbreaker - package io.github.resilience4j.circuitbreaker
 
io.github.resilience4j.circuitbreaker.event - package io.github.resilience4j.circuitbreaker.event
 
io.github.resilience4j.circuitbreaker.internal - package io.github.resilience4j.circuitbreaker.internal
 
io.github.resilience4j.circuitbreaker.utils - package io.github.resilience4j.circuitbreaker.utils
 
isAutomaticTransitionFromOpenToHalfOpenEnabled() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
 
isCallPermitted(CircuitBreaker) - Static method in class io.github.resilience4j.circuitbreaker.utils.CircuitBreakerUtil
Indicates whether Circuit Breaker allows any calls or not.
isCancelled() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreaker.CircuitBreakerFuture
 
isDone() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreaker.CircuitBreakerFuture
 
isWritableStackTraceEnabled() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
 

M

MetricNames - Class in io.github.resilience4j.circuitbreaker.utils
 
MetricNames() - Constructor for class io.github.resilience4j.circuitbreaker.utils.MetricNames
 
minimumNumberOfCalls(int) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
Configures the minimum number of calls which are required (per sliding window period) before the CircuitBreaker can calculate the error rate.

N

NOT_PERMITTED - Static variable in class io.github.resilience4j.circuitbreaker.utils.MetricNames
 

O

of(String, CircuitBreakerConfig) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Creates a CircuitBreaker with a custom CircuitBreaker configuration.
of(String, CircuitBreakerConfig, Map<String, String>) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Creates a CircuitBreaker with a custom CircuitBreaker configuration.
of(String, Supplier<CircuitBreakerConfig>) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Creates a CircuitBreaker with a custom CircuitBreaker configuration.
of(String, Supplier<CircuitBreakerConfig>, Map<String, String>) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Creates a CircuitBreaker with a custom CircuitBreaker configuration.
of(CircuitBreakerConfig) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry
Creates a CircuitBreakerRegistry with a custom default CircuitBreaker configuration.
of(CircuitBreakerConfig, RegistryEventConsumer<CircuitBreaker>) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry
Creates a CircuitBreakerRegistry with a custom default CircuitBreaker configuration and a CircuitBreaker registry event consumer.
of(CircuitBreakerConfig, List<RegistryEventConsumer<CircuitBreaker>>) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry
Creates a CircuitBreakerRegistry with a custom default CircuitBreaker configuration and a list of CircuitBreaker registry event consumers.
of(Map<String, CircuitBreakerConfig>) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry
Creates a CircuitBreakerRegistry with a Map of shared CircuitBreaker configurations.
of(Map<String, CircuitBreakerConfig>, Map<String, String>) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry
Creates a CircuitBreakerRegistry with a Map of shared CircuitBreaker configurations.
of(Map<String, CircuitBreakerConfig>, RegistryEventConsumer<CircuitBreaker>) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry
Creates a CircuitBreakerRegistry with a Map of shared CircuitBreaker configurations and a CircuitBreaker registry event consumer.
of(Map<String, CircuitBreakerConfig>, List<RegistryEventConsumer<CircuitBreaker>>) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry
Creates a CircuitBreakerRegistry with a Map of shared CircuitBreaker configurations and a list of CircuitBreaker registry event consumers.
ofDefaults(String) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Creates a CircuitBreaker with a default CircuitBreaker configuration.
ofDefaults() - Static method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
Creates a default CircuitBreaker configuration.
ofDefaults() - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry
Creates a CircuitBreakerRegistry with a default CircuitBreaker configuration.
onCallNotPermitted(EventConsumer<CircuitBreakerOnCallNotPermittedEvent>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker.EventPublisher
 
onError(EventConsumer<CircuitBreakerOnErrorEvent>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker.EventPublisher
 
onError(long, TimeUnit, Throwable) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Records a failed call.
onError(long, TimeUnit, Throwable) - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
 
onIgnoredError(EventConsumer<CircuitBreakerOnIgnoredErrorEvent>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker.EventPublisher
 
onReset(EventConsumer<CircuitBreakerOnResetEvent>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker.EventPublisher
 
onStateTransition(EventConsumer<CircuitBreakerOnStateTransitionEvent>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker.EventPublisher
 
onSuccess(EventConsumer<CircuitBreakerOnSuccessEvent>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker.EventPublisher
 
onSuccess(long, TimeUnit) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Records a successful call.
onSuccess(long, TimeUnit) - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
 

P

permittedNumberOfCallsInHalfOpenState(int) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
Configures the number of permitted calls when the CircuitBreaker is half open.

R

recordException(Predicate<Throwable>) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
Configures a Predicate which evaluates if an exception should be recorded as a failure and thus increase the failure rate.
recordExceptions(Class<? extends Throwable>...) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
Configures a list of error classes that are recorded as a failure and thus increase the failure rate.
recordFailure(Predicate<Throwable>) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
releasePermission() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Releases a permission.
releasePermission() - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
 
reset() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Returns the circuit breaker to its original closed state, losing statistics.
reset() - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
 
ringBufferSizeInClosedState(int) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
Deprecated.
Use #slidingWindow(int, int, SlidingWindowType) instead.
ringBufferSizeInHalfOpenState(int) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder

S

SchedulerFactory - Class in io.github.resilience4j.circuitbreaker.internal
 
slidingWindow(int, int, CircuitBreakerConfig.SlidingWindowType) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
Configures the sliding window which is used to record the outcome of calls when the CircuitBreaker is closed.
slidingWindowSize(int) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
Configures the size of the sliding window which is used to record the outcome of calls when the CircuitBreaker is closed.
slidingWindowType(CircuitBreakerConfig.SlidingWindowType) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
Configures the type of the sliding window which is used to record the outcome of calls when the CircuitBreaker is closed.
SLOW - Static variable in class io.github.resilience4j.circuitbreaker.utils.MetricNames
 
SLOW_CALL_RATE - Static variable in class io.github.resilience4j.circuitbreaker.utils.MetricNames
 
SLOW_FAILED - Static variable in class io.github.resilience4j.circuitbreaker.utils.MetricNames
 
SLOW_SUCCESS - Static variable in class io.github.resilience4j.circuitbreaker.utils.MetricNames
 
slowCallDurationThreshold(Duration) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
Configures the duration threshold above which calls are considered as slow and increase the slow calls percentage.
slowCallRateThreshold(float) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
Configures a threshold in percentage.
STATE - Static variable in class io.github.resilience4j.circuitbreaker.utils.MetricNames
 
SUCCESSFUL - Static variable in class io.github.resilience4j.circuitbreaker.utils.MetricNames
 

T

toString() - Method in enum io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
 
toString() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnCallNotPermittedEvent
 
toString() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnErrorEvent
 
toString() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnIgnoredErrorEvent
 
toString() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnResetEvent
 
toString() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnStateTransitionEvent
 
toString() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnSuccessEvent
 
toString() - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
transitionBetween(String, CircuitBreaker.State, CircuitBreaker.State) - Static method in enum io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
 
transitionToClosedState() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Transitions the state machine to CLOSED state.
transitionToClosedState() - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
 
transitionToDisabledState() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Transitions the state machine to a DISABLED state, stopping state transition, metrics and event publishing.
transitionToDisabledState() - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
 
transitionToForcedOpenState() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Transitions the state machine to a FORCED_OPEN state, stopping state transition, metrics and event publishing.
transitionToForcedOpenState() - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
 
transitionToHalfOpenState() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Transitions the state machine to HALF_OPEN state.
transitionToHalfOpenState() - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
 
transitionToOpenState() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Transitions the state machine to OPEN state.
transitionToOpenState() - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
 
tryAcquirePermission() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
Acquires a permission to execute a call, only if one is available at the time of invocation.
tryAcquirePermission() - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
 

V

valueOf(String) - Static method in enum io.github.resilience4j.circuitbreaker.CircuitBreaker.State
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.SlidingWindowType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.github.resilience4j.circuitbreaker.event.CircuitBreakerEvent.Type
Returns the enum constant of this type with the specified name.
values() - Static method in enum io.github.resilience4j.circuitbreaker.CircuitBreaker.State
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.SlidingWindowType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.github.resilience4j.circuitbreaker.event.CircuitBreakerEvent.Type
Returns an array containing the constants of this enum type, in the order they are declared.

W

waitDurationInOpenState(Duration) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
Configures an interval function with a fixed wait duration which controls how long the CircuitBreaker should stay open, before it switches to half open.
waitIntervalFunctionInOpenState(IntervalFunction) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
Configures an interval function which controls how long the CircuitBreaker should stay open, before it switches to half open.
writableStackTraceEnabled(boolean) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
Enables writable stack traces.
A B C D E F G I M N O P R S T V W 
Skip navigation links