CircuitBreakerBuilder (filter-service-metrics 1.13 1.13 API)

java.lang.Object
- com.linecorp.armeria.client.circuitbreaker.CircuitBreakerBuilder

public final class CircuitBreakerBuilder
extends Object

Builds a CircuitBreaker instance using builder pattern.

Constructor Summary

Constructors
Constructor and Description
`CircuitBreakerBuilder()` Deprecated. Use `CircuitBreaker.builder()`.
`CircuitBreakerBuilder(String name)` Deprecated. Use `CircuitBreaker.builder(String)`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CircuitBreaker`	`build()` Returns a newly-created `CircuitBreaker` based on the properties of this builder.
`CircuitBreakerBuilder`	`circuitOpenWindow(Duration circuitOpenWindow)` Sets the duration of OPEN state.
`CircuitBreakerBuilder`	`circuitOpenWindowMillis(long circuitOpenWindowMillis)` Sets the duration of OPEN state in milliseconds.
`CircuitBreakerBuilder`	`counterSlidingWindow(Duration counterSlidingWindow)` Sets the time length of sliding window to accumulate the count of events.
`CircuitBreakerBuilder`	`counterSlidingWindowMillis(long counterSlidingWindowMillis)` Sets the time length of sliding window to accumulate the count of events, in milliseconds.
`CircuitBreakerBuilder`	`counterUpdateInterval(Duration counterUpdateInterval)` Sets the interval that a circuit breaker can see the latest accumulated count of events.
`CircuitBreakerBuilder`	`counterUpdateIntervalMillis(long counterUpdateIntervalMillis)` Sets the interval that a circuit breaker can see the latest accumulated count of events, in milliseconds.
`CircuitBreakerBuilder`	`failureRateThreshold(double failureRateThreshold)` Sets the threshold of failure rate to detect a remote service fault.
`CircuitBreakerBuilder`	`listener(CircuitBreakerListener listener)` Adds a `CircuitBreakerListener`.
`CircuitBreakerBuilder`	`minimumRequestThreshold(long minimumRequestThreshold)` Sets the minimum number of requests within a time window necessary to detect a remote service fault.
`CircuitBreakerBuilder`	`trialRequestInterval(Duration trialRequestInterval)` Sets the trial request interval in HALF_OPEN state.
`CircuitBreakerBuilder`	`trialRequestIntervalMillis(long trialRequestIntervalMillis)` Sets the trial request interval in HALF_OPEN state in milliseconds.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CircuitBreakerBuilder
```
@Deprecated
public CircuitBreakerBuilder(String name)
```
    Deprecated. Use CircuitBreaker.builder(String).
    
    Creates a new CircuitBreakerBuilder with the specified name.
    
    Parameters:
    
    name - The name of the circuit breaker.
  - CircuitBreakerBuilder
```
@Deprecated
public CircuitBreakerBuilder()
```
    Deprecated. Use CircuitBreaker.builder().
    
    Creates a new CircuitBreakerBuilder.
- Method Detail
  - failureRateThreshold
```
public CircuitBreakerBuilder failureRateThreshold(double failureRateThreshold)
```
    Sets the threshold of failure rate to detect a remote service fault. Defaults to if unspecified.
    
    Parameters:
    
    failureRateThreshold - The rate between 0 (exclusive) and 1 (inclusive)
  - minimumRequestThreshold
```
public CircuitBreakerBuilder minimumRequestThreshold(long minimumRequestThreshold)
```
    Sets the minimum number of requests within a time window necessary to detect a remote service fault. Defaults to if unspecified.
  - trialRequestInterval
```
public CircuitBreakerBuilder trialRequestInterval(Duration trialRequestInterval)
```
    Sets the trial request interval in HALF_OPEN state. Defaults to seconds if unspecified.
  - trialRequestIntervalMillis
```
public CircuitBreakerBuilder trialRequestIntervalMillis(long trialRequestIntervalMillis)
```
    Sets the trial request interval in HALF_OPEN state in milliseconds. Defaults to seconds if unspecified.
  - circuitOpenWindow
```
public CircuitBreakerBuilder circuitOpenWindow(Duration circuitOpenWindow)
```
    Sets the duration of OPEN state. Defaults to seconds if unspecified.
  - circuitOpenWindowMillis
```
public CircuitBreakerBuilder circuitOpenWindowMillis(long circuitOpenWindowMillis)
```
    Sets the duration of OPEN state in milliseconds. Defaults to seconds if unspecified.
  - counterSlidingWindow
```
public CircuitBreakerBuilder counterSlidingWindow(Duration counterSlidingWindow)
```
    Sets the time length of sliding window to accumulate the count of events. Defaults to seconds if unspecified.
  - counterSlidingWindowMillis
```
public CircuitBreakerBuilder counterSlidingWindowMillis(long counterSlidingWindowMillis)
```
    Sets the time length of sliding window to accumulate the count of events, in milliseconds. Defaults to seconds if unspecified.
  - counterUpdateInterval
```
public CircuitBreakerBuilder counterUpdateInterval(Duration counterUpdateInterval)
```
    Sets the interval that a circuit breaker can see the latest accumulated count of events. Defaults to second if unspecified.
  - counterUpdateIntervalMillis
```
public CircuitBreakerBuilder counterUpdateIntervalMillis(long counterUpdateIntervalMillis)
```
    Sets the interval that a circuit breaker can see the latest accumulated count of events, in milliseconds. Defaults to second if unspecified.
  - listener
```
public CircuitBreakerBuilder listener(CircuitBreakerListener listener)
```
    Adds a CircuitBreakerListener.
  - build
```
public CircuitBreaker build()
```
    Returns a newly-created CircuitBreaker based on the properties of this builder.

Class CircuitBreakerBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CircuitBreakerBuilder

CircuitBreakerBuilder

Method Detail

failureRateThreshold

minimumRequestThreshold

trialRequestInterval

trialRequestIntervalMillis

circuitOpenWindow

circuitOpenWindowMillis

counterSlidingWindow

counterSlidingWindowMillis

counterUpdateInterval

counterUpdateIntervalMillis

listener

build