Package io.github.resilience4j.common.circuitbreaker.configuration

Class CommonCircuitBreakerConfigurationProperties.InstanceProperties

java.lang.Object

io.github.resilience4j.common.circuitbreaker.configuration.CommonCircuitBreakerConfigurationProperties.InstanceProperties

Enclosing class:

CommonCircuitBreakerConfigurationProperties

public static class CommonCircuitBreakerConfigurationProperties.InstanceProperties
extends Object

Class storing property values for configuring CircuitBreaker instances.

Constructor Summary

Constructors

Constructor	Description
InstanceProperties()

Method Summary

Modifier and Type	Method	Description
Boolean	getAllowHealthIndicatorToFail()
Boolean	getAutomaticTransitionFromOpenToHalfOpenEnabled()	Returns if we should automatically transition to half open after the timer has run out.
String	getBaseConfig()	Gets the shared configuration name.
Boolean	getEnableExponentialBackoff()
Boolean	getEnableRandomizedWait()
Integer	getEventConsumerBufferSize()
Double	getExponentialBackoffMultiplier()
Duration	getExponentialMaxWaitDurationInOpenState()
Float	getFailureRateThreshold()	Returns the failure rate threshold for the circuit breaker as percentage.
Boolean	getIgnoreClassBindingExceptions()
Class<Predicate<Throwable>>	getIgnoreExceptionPredicate()
Class<? extends Throwable>[]	getIgnoreExceptions()
Duration	getMaxWaitDurationInHalfOpenState()
Integer	getMinimumNumberOfCalls()
Integer	getPermittedNumberOfCallsInHalfOpenState()
Double	getRandomizedWaitFactor()
Class<? extends Throwable>[]	getRecordExceptions()
Class<Predicate<Throwable>>	getRecordFailurePredicate()
Class<Predicate<Object>>	getRecordResultPredicate()
Boolean	getRegisterHealthIndicator()
Integer	getSlidingWindowSize()
io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.SlidingWindowType	getSlidingWindowType()
Duration	getSlowCallDurationThreshold()
Float	getSlowCallRateThreshold()
Duration	getWaitDurationInOpenState()	Returns the wait duration the CircuitBreaker will stay open, before it switches to half closed.
Boolean	getWritableStackTraceEnabled()	Returns if we should enable writable stack traces or not.
CommonCircuitBreakerConfigurationProperties.InstanceProperties	setAllowHealthIndicatorToFail(Boolean allowHealthIndicatorToFail)	When set to true, it allows the health indicator to go to a failed (DOWN) status.
CommonCircuitBreakerConfigurationProperties.InstanceProperties	setAutomaticTransitionFromOpenToHalfOpenEnabled(Boolean automaticTransitionFromOpenToHalfOpenEnabled)	Sets if we should automatically transition to half open after the timer has run out.
CommonCircuitBreakerConfigurationProperties.InstanceProperties	setBaseConfig(String baseConfig)	Sets the shared configuration name.
CommonCircuitBreakerConfigurationProperties.InstanceProperties	setEnableExponentialBackoff(Boolean enableExponentialBackoff)
CommonCircuitBreakerConfigurationProperties.InstanceProperties	setEnableRandomizedWait(Boolean enableRandomizedWait)
CommonCircuitBreakerConfigurationProperties.InstanceProperties	setEventConsumerBufferSize(Integer eventConsumerBufferSize)
CommonCircuitBreakerConfigurationProperties.InstanceProperties	setExponentialBackoffMultiplier(Double exponentialBackoffMultiplier)
CommonCircuitBreakerConfigurationProperties.InstanceProperties	setExponentialMaxWaitDurationInOpenState(Duration exponentialMaxWaitDurationInOpenState)
CommonCircuitBreakerConfigurationProperties.InstanceProperties	setFailureRateThreshold(Float failureRateThreshold)	Sets the failure rate threshold for the circuit breaker as percentage.
CommonCircuitBreakerConfigurationProperties.InstanceProperties	setIgnoreClassBindingExceptions(Boolean ignoreClassBindingExceptions)
CommonCircuitBreakerConfigurationProperties.InstanceProperties	setIgnoreExceptionPredicate(Class<Predicate<Throwable>> ignoreExceptionPredicate)
CommonCircuitBreakerConfigurationProperties.InstanceProperties	setIgnoreExceptions(Class<? extends Throwable>[] ignoreExceptions)
CommonCircuitBreakerConfigurationProperties.InstanceProperties	setMaxWaitDurationInHalfOpenState(Duration maxWaitDurationInHalfOpenState)
CommonCircuitBreakerConfigurationProperties.InstanceProperties	setMinimumNumberOfCalls(Integer minimumNumberOfCalls)
CommonCircuitBreakerConfigurationProperties.InstanceProperties	setPermittedNumberOfCallsInHalfOpenState(Integer permittedNumberOfCallsInHalfOpenState)
CommonCircuitBreakerConfigurationProperties.InstanceProperties	setRandomizedWaitFactor(Double randomizedWaitFactor)
CommonCircuitBreakerConfigurationProperties.InstanceProperties	setRecordExceptions(Class<? extends Throwable>[] recordExceptions)
CommonCircuitBreakerConfigurationProperties.InstanceProperties	setRecordFailurePredicate(Class<Predicate<Throwable>> recordFailurePredicate)
CommonCircuitBreakerConfigurationProperties.InstanceProperties	setRecordResultPredicate(Class<Predicate<Object>> recordResultPredicate)
CommonCircuitBreakerConfigurationProperties.InstanceProperties	setRegisterHealthIndicator(Boolean registerHealthIndicator)
CommonCircuitBreakerConfigurationProperties.InstanceProperties	setSlidingWindowSize(Integer slidingWindowSize)
CommonCircuitBreakerConfigurationProperties.InstanceProperties	setSlidingWindowType(io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.SlidingWindowType slidingWindowType)
CommonCircuitBreakerConfigurationProperties.InstanceProperties	setSlowCallDurationThreshold(Duration slowCallDurationThreshold)
CommonCircuitBreakerConfigurationProperties.InstanceProperties	setSlowCallRateThreshold(Float slowCallRateThreshold)
CommonCircuitBreakerConfigurationProperties.InstanceProperties	setWaitDurationInOpenState(Duration waitDurationInOpenStateMillis)	Sets the wait duration the CircuitBreaker should stay open, before it switches to half closed.
CommonCircuitBreakerConfigurationProperties.InstanceProperties	setWritableStackTraceEnabled(Boolean writableStackTraceEnabled)	Sets if we should enable writable stack traces or not.

Methods inherited from class java.lang.Object

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

Constructor Details

InstanceProperties

public InstanceProperties()

Method Details

getFailureRateThreshold

@Nullable
public Float getFailureRateThreshold()

Returns the failure rate threshold for the circuit breaker as percentage.

Returns:

the failure rate threshold

setFailureRateThreshold

public CommonCircuitBreakerConfigurationProperties.InstanceProperties setFailureRateThreshold(Float failureRateThreshold)

Sets the failure rate threshold for the circuit breaker as percentage.

Parameters:

failureRateThreshold - the failure rate threshold

getWaitDurationInOpenState

@Nullable
public Duration getWaitDurationInOpenState()

Returns the wait duration the CircuitBreaker will stay open, before it switches to half closed.

Returns:

the wait duration

setWaitDurationInOpenState

public CommonCircuitBreakerConfigurationProperties.InstanceProperties setWaitDurationInOpenState(Duration waitDurationInOpenStateMillis)

Sets the wait duration the CircuitBreaker should stay open, before it switches to half closed.

Parameters:

waitDurationInOpenStateMillis - the wait duration

getAutomaticTransitionFromOpenToHalfOpenEnabled

public Boolean getAutomaticTransitionFromOpenToHalfOpenEnabled()

Returns if we should automatically transition to half open after the timer has run out.

Returns:

setAutomaticTransitionFromOpenToHalfOpenEnabled if we should automatically go to half open or not

setAutomaticTransitionFromOpenToHalfOpenEnabled

public CommonCircuitBreakerConfigurationProperties.InstanceProperties setAutomaticTransitionFromOpenToHalfOpenEnabled(Boolean automaticTransitionFromOpenToHalfOpenEnabled)

Sets if we should automatically transition to half open after the timer has run out.

Parameters:

automaticTransitionFromOpenToHalfOpenEnabled - The flag for automatic transition to half open after the timer has run out.

getWritableStackTraceEnabled

@Nullable
public Boolean getWritableStackTraceEnabled()

Returns if we should enable writable stack traces or not.

Returns:

writableStackTraceEnabled if we should enable writable stack traces or not.

setWritableStackTraceEnabled

public CommonCircuitBreakerConfigurationProperties.InstanceProperties setWritableStackTraceEnabled(Boolean writableStackTraceEnabled)

Sets if we should enable writable stack traces or not.

Parameters:

writableStackTraceEnabled - The flag to enable writable stack traces.

getEventConsumerBufferSize

@Nullable
public Integer getEventConsumerBufferSize()

setEventConsumerBufferSize

public CommonCircuitBreakerConfigurationProperties.InstanceProperties setEventConsumerBufferSize(Integer eventConsumerBufferSize)

getAllowHealthIndicatorToFail

@Nullable
public Boolean getAllowHealthIndicatorToFail()

Returns:

the flag that controls if health indicators are allowed to go into a failed (DOWN) status.

See Also:

• setAllowHealthIndicatorToFail(Boolean)

setAllowHealthIndicatorToFail

public CommonCircuitBreakerConfigurationProperties.InstanceProperties setAllowHealthIndicatorToFail(Boolean allowHealthIndicatorToFail)

When set to true, it allows the health indicator to go to a failed (DOWN) status. By default, health indicators for circuit breakers will never go into an unhealthy state.

Parameters:

allowHealthIndicatorToFail - flag to control if the health indicator is allowed to fail

Returns:

the InstanceProperties

getRegisterHealthIndicator

@Nullable
public Boolean getRegisterHealthIndicator()

setRegisterHealthIndicator

public CommonCircuitBreakerConfigurationProperties.InstanceProperties setRegisterHealthIndicator(Boolean registerHealthIndicator)

getRecordFailurePredicate

@Nullable
public Class<Predicate<Throwable>> getRecordFailurePredicate()

setRecordFailurePredicate

public CommonCircuitBreakerConfigurationProperties.InstanceProperties setRecordFailurePredicate(Class<Predicate<Throwable>> recordFailurePredicate)

getRecordResultPredicate

@Nullable
public Class<Predicate<Object>> getRecordResultPredicate()

setRecordResultPredicate

public CommonCircuitBreakerConfigurationProperties.InstanceProperties setRecordResultPredicate(Class<Predicate<Object>> recordResultPredicate)

getRecordExceptions

@Nullable
public Class<? extends Throwable>[] getRecordExceptions()

setRecordExceptions

public CommonCircuitBreakerConfigurationProperties.InstanceProperties setRecordExceptions(Class<? extends Throwable>[] recordExceptions)

getIgnoreExceptionPredicate

@Nullable
public Class<Predicate<Throwable>> getIgnoreExceptionPredicate()

setIgnoreExceptionPredicate

public CommonCircuitBreakerConfigurationProperties.InstanceProperties setIgnoreExceptionPredicate(Class<Predicate<Throwable>> ignoreExceptionPredicate)

getIgnoreExceptions

@Nullable
public Class<? extends Throwable>[] getIgnoreExceptions()

setIgnoreExceptions

public CommonCircuitBreakerConfigurationProperties.InstanceProperties setIgnoreExceptions(Class<? extends Throwable>[] ignoreExceptions)

getBaseConfig

@Nullable
public String getBaseConfig()

Gets the shared configuration name. If this is set, the configuration builder will use the shared configuration backend over this one.

Returns:

The shared configuration name.

setBaseConfig

public CommonCircuitBreakerConfigurationProperties.InstanceProperties setBaseConfig(String baseConfig)

Sets the shared configuration name. If this is set, the configuration builder will use the shared configuration backend over this one.

Parameters:

baseConfig - The shared configuration name.

getPermittedNumberOfCallsInHalfOpenState

@Nullable
public Integer getPermittedNumberOfCallsInHalfOpenState()

setPermittedNumberOfCallsInHalfOpenState

public CommonCircuitBreakerConfigurationProperties.InstanceProperties setPermittedNumberOfCallsInHalfOpenState(Integer permittedNumberOfCallsInHalfOpenState)

getMinimumNumberOfCalls

@Nullable
public Integer getMinimumNumberOfCalls()

setMinimumNumberOfCalls

public CommonCircuitBreakerConfigurationProperties.InstanceProperties setMinimumNumberOfCalls(Integer minimumNumberOfCalls)

getSlidingWindowSize

@Nullable
public Integer getSlidingWindowSize()

setSlidingWindowSize

public CommonCircuitBreakerConfigurationProperties.InstanceProperties setSlidingWindowSize(Integer slidingWindowSize)

getSlowCallRateThreshold

@Nullable
public Float getSlowCallRateThreshold()

setSlowCallRateThreshold

public CommonCircuitBreakerConfigurationProperties.InstanceProperties setSlowCallRateThreshold(Float slowCallRateThreshold)

getSlowCallDurationThreshold

@Nullable
public Duration getSlowCallDurationThreshold()

getMaxWaitDurationInHalfOpenState

@Nullable
public Duration getMaxWaitDurationInHalfOpenState()

setSlowCallDurationThreshold

public CommonCircuitBreakerConfigurationProperties.InstanceProperties setSlowCallDurationThreshold(Duration slowCallDurationThreshold)

setMaxWaitDurationInHalfOpenState

public CommonCircuitBreakerConfigurationProperties.InstanceProperties setMaxWaitDurationInHalfOpenState(Duration maxWaitDurationInHalfOpenState)

getSlidingWindowType

@Nullable
public io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.SlidingWindowType getSlidingWindowType()

setSlidingWindowType

public CommonCircuitBreakerConfigurationProperties.InstanceProperties setSlidingWindowType(io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.SlidingWindowType slidingWindowType)

getEnableExponentialBackoff

public Boolean getEnableExponentialBackoff()

setEnableExponentialBackoff

public CommonCircuitBreakerConfigurationProperties.InstanceProperties setEnableExponentialBackoff(Boolean enableExponentialBackoff)

getExponentialBackoffMultiplier

@Nullable
public Double getExponentialBackoffMultiplier()

setExponentialBackoffMultiplier

public CommonCircuitBreakerConfigurationProperties.InstanceProperties setExponentialBackoffMultiplier(Double exponentialBackoffMultiplier)

getExponentialMaxWaitDurationInOpenState

@Nullable
public Duration getExponentialMaxWaitDurationInOpenState()

setExponentialMaxWaitDurationInOpenState

public CommonCircuitBreakerConfigurationProperties.InstanceProperties setExponentialMaxWaitDurationInOpenState(Duration exponentialMaxWaitDurationInOpenState)

getEnableRandomizedWait

@Nullable
public Boolean getEnableRandomizedWait()

setEnableRandomizedWait

public CommonCircuitBreakerConfigurationProperties.InstanceProperties setEnableRandomizedWait(Boolean enableRandomizedWait)

getRandomizedWaitFactor

@Nullable
public Double getRandomizedWaitFactor()

setRandomizedWaitFactor

public CommonCircuitBreakerConfigurationProperties.InstanceProperties setRandomizedWaitFactor(Double randomizedWaitFactor)

getIgnoreClassBindingExceptions

@Nullable
public Boolean getIgnoreClassBindingExceptions()

setIgnoreClassBindingExceptions

public CommonCircuitBreakerConfigurationProperties.InstanceProperties setIgnoreClassBindingExceptions(Boolean ignoreClassBindingExceptions)