com.sap.cloud.sdk.cloudplatform.resilience

Class ResilienceConfiguration.CircuitBreakerConfiguration

java.lang.Object

com.sap.cloud.sdk.cloudplatform.resilience.ResilienceConfiguration.CircuitBreakerConfiguration

Enclosing class:

ResilienceConfiguration

public static final class ResilienceConfiguration.CircuitBreakerConfiguration
extends Object

Provides options specific to circuit breakers.

See Also:

Circuit Breakers

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_CLOSED_BUFFER_SIZE The default size of the buffer in CLOSED state.
static float	DEFAULT_FAILURE_RATE_THRESHOLD The default threshold at which to transition to the OPEN state.
static int	DEFAULT_HALF_OPEN_BUFFER_SIZE The default size of the buffer in HALF OPEN state.
static Duration	DEFAULT_WAIT_DURATION The default duration to wait in OPEN state before transitioning into the HALF OPEN state.

Method Summary

Modifier and Type	Method and Description
int	closedBufferSize() The number of latest attempts in the CLOSED state to apply the threshold to.
ResilienceConfiguration.CircuitBreakerConfiguration	closedBufferSize(int closedBufferSize) The number of latest attempts in the CLOSED state to apply the threshold to.
static ResilienceConfiguration.CircuitBreakerConfiguration	disabled() Creates a disabled CircuitBreakerConfiguration.
boolean	equals(Object o)
float	failureRateThreshold() The failure rate threshold (as percentage within [0, 100]).
ResilienceConfiguration.CircuitBreakerConfiguration	failureRateThreshold(float failureRateThreshold) The failure rate threshold (as percentage within [0, 100]).
int	halfOpenBufferSize() The number of latest attempts in the HALF OPEN state that must succeed in order to transition to the CLOSED state.
ResilienceConfiguration.CircuitBreakerConfiguration	halfOpenBufferSize(int halfOpenBufferSize) The number of latest attempts in the HALF OPEN state that must succeed in order to transition to the CLOSED state.
int	hashCode()
boolean	isEnabled() Get the status indicator for the CircuitBreaker.
static ResilienceConfiguration.CircuitBreakerConfiguration	of()
@NonNull Duration	waitDuration() The wait duration in the OPEN state before transitioning into the HALF OPEN state.
ResilienceConfiguration.CircuitBreakerConfiguration	waitDuration(@NonNull Duration waitDuration) The wait duration in the OPEN state before transitioning into the HALF OPEN state.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FAILURE_RATE_THRESHOLD

public static final float DEFAULT_FAILURE_RATE_THRESHOLD

The default threshold at which to transition to the OPEN state.

See Also:

Constant Field Values

DEFAULT_CLOSED_BUFFER_SIZE

public static final int DEFAULT_CLOSED_BUFFER_SIZE

The default size of the buffer in CLOSED state.

See Also:

Constant Field Values

DEFAULT_HALF_OPEN_BUFFER_SIZE

public static final int DEFAULT_HALF_OPEN_BUFFER_SIZE

The default size of the buffer in HALF OPEN state.

See Also:

Constant Field Values

DEFAULT_WAIT_DURATION

public static final Duration DEFAULT_WAIT_DURATION

The default duration to wait in OPEN state before transitioning into the HALF OPEN state.

Method Detail

isEnabled

public boolean isEnabled()

Get the status indicator for the CircuitBreaker.

Returns:

True if the configuration is enabled.

disabled

@Nonnull
public static ResilienceConfiguration.CircuitBreakerConfiguration disabled()

Creates a disabled CircuitBreakerConfiguration.

Returns:

A disabled time limiter.

of

public static ResilienceConfiguration.CircuitBreakerConfiguration of()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

failureRateThreshold

public float failureRateThreshold()

The failure rate threshold (as percentage within [0, 100]).

waitDuration

@NonNull
public @NonNull Duration waitDuration()

The wait duration in the OPEN state before transitioning into the HALF OPEN state.

closedBufferSize

public int closedBufferSize()

The number of latest attempts in the CLOSED state to apply the threshold to. If the failure rate over the last closedRingBufferSize calls exceeds the threshold, the circuit breaker will block further calls (OPEN state). Be aware that this is the minimum number of attempts that must have occurred before the circuit breaker can take effect.

halfOpenBufferSize

public int halfOpenBufferSize()

The number of latest attempts in the HALF OPEN state that must succeed in order to transition to the CLOSED state.

failureRateThreshold

public ResilienceConfiguration.CircuitBreakerConfiguration failureRateThreshold(float failureRateThreshold)

The failure rate threshold (as percentage within [0, 100]).

Returns:

this

waitDuration

public ResilienceConfiguration.CircuitBreakerConfiguration waitDuration(@NonNull
                                                                        @NonNull Duration waitDuration)

The wait duration in the OPEN state before transitioning into the HALF OPEN state.

Returns:

this

closedBufferSize

public ResilienceConfiguration.CircuitBreakerConfiguration closedBufferSize(int closedBufferSize)

The number of latest attempts in the CLOSED state to apply the threshold to. If the failure rate over the last closedRingBufferSize calls exceeds the threshold, the circuit breaker will block further calls (OPEN state). Be aware that this is the minimum number of attempts that must have occurred before the circuit breaker can take effect.

Returns:

this

halfOpenBufferSize

public ResilienceConfiguration.CircuitBreakerConfiguration halfOpenBufferSize(int halfOpenBufferSize)

The number of latest attempts in the HALF OPEN state that must succeed in order to transition to the CLOSED state.

Returns:

this