io.github.resilience4j.circuitbreaker

Class CircuitBreakerConfig.Builder

java.lang.Object

io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder

Enclosing class:

CircuitBreakerConfig

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CircuitBreakerConfig	build() Builds a CircuitBreakerConfig
CircuitBreakerConfig.Builder	failureRateThreshold(float failureRateThreshold) Configures the failure rate threshold in percentage above which the CircuitBreaker should trip open and start short-circuiting calls.
CircuitBreakerConfig.Builder	recordFailure(java.util.function.Predicate<? super java.lang.Throwable> predicate) Configures a Predicate which evaluates if an exception should be recorded as a failure and thus increase the failure rate.
CircuitBreakerConfig.Builder	ringBufferSizeInClosedState(int ringBufferSizeInClosedState) Configures the size of the ring buffer when the CircuitBreaker is closed.
CircuitBreakerConfig.Builder	ringBufferSizeInHalfOpenState(int ringBufferSizeInHalfOpenState) Configures the size of the ring buffer when the CircuitBreaker is half open.
CircuitBreakerConfig.Builder	waitDurationInOpenState(java.time.Duration waitDurationInOpenState) Configures the wait duration which specifies how long the CircuitBreaker should stay open, before it switches to half open.

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

failureRateThreshold

public CircuitBreakerConfig.Builder failureRateThreshold(float failureRateThreshold)

Configures the failure rate threshold in percentage above which the CircuitBreaker should trip open and start short-circuiting calls. The threshold must be greater than 0 and not greater than 100. Default value is 50 percentage.

Parameters:

failureRateThreshold - the failure rate threshold in percentage

Returns:

the CircuitBreakerConfig.Builder

waitDurationInOpenState

public CircuitBreakerConfig.Builder waitDurationInOpenState(java.time.Duration waitDurationInOpenState)

Configures the wait duration which specifies how long the CircuitBreaker should stay open, before it switches to half open. Default value is 60 seconds.

Parameters:

waitDurationInOpenState - the wait duration which specifies how long the CircuitBreaker should stay open

Returns:

the CircuitBreakerConfig.Builder

ringBufferSizeInHalfOpenState

public CircuitBreakerConfig.Builder ringBufferSizeInHalfOpenState(int ringBufferSizeInHalfOpenState)

Configures the size of the ring buffer when the CircuitBreaker is half open. The CircuitBreaker stores the success/failure success / failure status of the latest calls in a ring buffer. For example, if ringBufferSizeInClosedState is 10, then at least 10 calls must be evaluated, before the failure rate can be calculated. If only 9 calls have been evaluated the CircuitBreaker will not trip back to closed or open even if all 9 calls have failed. The size must be greater than 0. Default size is 10.

Parameters:

ringBufferSizeInHalfOpenState - the size of the ring buffer when the CircuitBreaker is is half open

Returns:

the CircuitBreakerConfig.Builder

ringBufferSizeInClosedState

public CircuitBreakerConfig.Builder ringBufferSizeInClosedState(int ringBufferSizeInClosedState)

Configures the size of the ring buffer when the CircuitBreaker is closed. The CircuitBreaker stores the success/failure success / failure status of the latest calls in a ring buffer. For example, if ringBufferSizeInClosedState is 100, then at least 100 calls must be evaluated, before the failure rate can be calculated. If only 99 calls have been evaluated the CircuitBreaker will not trip open even if all 99 calls have failed. The size must be greater than 0. Default size is 100.

Parameters:

ringBufferSizeInClosedState - the size of the ring buffer when the CircuitBreaker is closed.

Returns:

the CircuitBreakerConfig.Builder

recordFailure

public CircuitBreakerConfig.Builder recordFailure(java.util.function.Predicate<? super java.lang.Throwable> predicate)

Configures a Predicate which evaluates if an exception should be recorded as a failure and thus increase the failure rate. The Predicate must return true if the exception should count as a failure, otherwise it must return false.

Parameters:

predicate - the Predicate which evaluates if an exception should be recorded as a failure and thus trigger the CircuitBreaker

Returns:

the CircuitBreakerConfig.Builder

build

public CircuitBreakerConfig build()

Builds a CircuitBreakerConfig

Returns:

the CircuitBreakerConfig