io.github.resilience4j.circuitbreaker

Class CircuitBreakerConfig

java.lang.Object

io.github.resilience4j.circuitbreaker.CircuitBreakerConfig

public class CircuitBreakerConfig
extends java.lang.Object

A CircuitBreakerConfig configures a CircuitBreaker

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CircuitBreakerConfig.Builder
static class	CircuitBreakerConfig.SlidingWindowType

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_FAILURE_RATE_THRESHOLD
static int	DEFAULT_MINIMUM_NUMBER_OF_CALLS
static int	DEFAULT_PERMITTED_CALLS_IN_HALF_OPEN_STATE
static int	DEFAULT_SLIDING_WINDOW_SIZE
static CircuitBreakerConfig.SlidingWindowType	DEFAULT_SLIDING_WINDOW_TYPE
static int	DEFAULT_SLOW_CALL_DURATION_THRESHOLD
static int	DEFAULT_SLOW_CALL_RATE_THRESHOLD
static int	DEFAULT_WAIT_DURATION_IN_OPEN_STATE
static boolean	DEFAULT_WRITABLE_STACK_TRACE_ENABLED

Method Summary

Modifier and Type	Method and Description
static CircuitBreakerConfig.Builder	custom() Returns a builder to create a custom CircuitBreakerConfig.
static CircuitBreakerConfig.Builder	from(CircuitBreakerConfig baseConfig) Returns a builder to create a custom CircuitBreakerConfig based on another CircuitBreakerConfig.
float	getFailureRateThreshold()
java.util.function.Predicate<java.lang.Throwable>	getIgnoreExceptionPredicate()
int	getMinimumNumberOfCalls()
int	getPermittedNumberOfCallsInHalfOpenState()
java.util.function.Predicate<java.lang.Throwable>	getRecordExceptionPredicate()
int	getSlidingWindowSize()
CircuitBreakerConfig.SlidingWindowType	getSlidingWindowType()
java.time.Duration	getSlowCallDurationThreshold()
float	getSlowCallRateThreshold()
java.time.Duration	getWaitDurationInOpenState()
boolean	isAutomaticTransitionFromOpenToHalfOpenEnabled()
boolean	isWritableStackTraceEnabled()
static CircuitBreakerConfig	ofDefaults() Creates a default CircuitBreaker configuration.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FAILURE_RATE_THRESHOLD

public static final int DEFAULT_FAILURE_RATE_THRESHOLD

See Also:

Constant Field Values

DEFAULT_SLOW_CALL_RATE_THRESHOLD

public static final int DEFAULT_SLOW_CALL_RATE_THRESHOLD

See Also:

Constant Field Values

DEFAULT_WAIT_DURATION_IN_OPEN_STATE

public static final int DEFAULT_WAIT_DURATION_IN_OPEN_STATE

See Also:

Constant Field Values

DEFAULT_PERMITTED_CALLS_IN_HALF_OPEN_STATE

public static final int DEFAULT_PERMITTED_CALLS_IN_HALF_OPEN_STATE

See Also:

Constant Field Values

DEFAULT_MINIMUM_NUMBER_OF_CALLS

public static final int DEFAULT_MINIMUM_NUMBER_OF_CALLS

See Also:

Constant Field Values

DEFAULT_SLIDING_WINDOW_SIZE

public static final int DEFAULT_SLIDING_WINDOW_SIZE

See Also:

Constant Field Values

DEFAULT_SLOW_CALL_DURATION_THRESHOLD

public static final int DEFAULT_SLOW_CALL_DURATION_THRESHOLD

See Also:

Constant Field Values

DEFAULT_SLIDING_WINDOW_TYPE

public static final CircuitBreakerConfig.SlidingWindowType DEFAULT_SLIDING_WINDOW_TYPE

DEFAULT_WRITABLE_STACK_TRACE_ENABLED

public static final boolean DEFAULT_WRITABLE_STACK_TRACE_ENABLED

See Also:

Constant Field Values

Method Detail

custom

public static CircuitBreakerConfig.Builder custom()

Returns a builder to create a custom CircuitBreakerConfig.

Returns:

a CircuitBreakerConfig.Builder

from

public static CircuitBreakerConfig.Builder from(CircuitBreakerConfig baseConfig)

Returns a builder to create a custom CircuitBreakerConfig based on another CircuitBreakerConfig.

Returns:

a CircuitBreakerConfig.Builder

ofDefaults

public static CircuitBreakerConfig ofDefaults()

Creates a default CircuitBreaker configuration.

Returns:

a default CircuitBreaker configuration.

getFailureRateThreshold

public float getFailureRateThreshold()

getWaitDurationInOpenState

public java.time.Duration getWaitDurationInOpenState()

getSlidingWindowSize

public int getSlidingWindowSize()

getRecordExceptionPredicate

public java.util.function.Predicate<java.lang.Throwable> getRecordExceptionPredicate()

getIgnoreExceptionPredicate

public java.util.function.Predicate<java.lang.Throwable> getIgnoreExceptionPredicate()

isAutomaticTransitionFromOpenToHalfOpenEnabled

public boolean isAutomaticTransitionFromOpenToHalfOpenEnabled()

getMinimumNumberOfCalls

public int getMinimumNumberOfCalls()

isWritableStackTraceEnabled

public boolean isWritableStackTraceEnabled()

getPermittedNumberOfCallsInHalfOpenState

public int getPermittedNumberOfCallsInHalfOpenState()

getSlidingWindowType

public CircuitBreakerConfig.SlidingWindowType getSlidingWindowType()

getSlowCallRateThreshold

public float getSlowCallRateThreshold()

getSlowCallDurationThreshold

public java.time.Duration getSlowCallDurationThreshold()