CircuitBreakerService (server 6.6.1 API)

java.lang.Object
- org.elasticsearch.common.component.AbstractLifecycleComponent
- - org.elasticsearch.indices.breaker.CircuitBreakerService

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, LifecycleComponent, Releasable

Direct Known Subclasses:

HierarchyCircuitBreakerService, NoneCircuitBreakerService
```
public abstract class CircuitBreakerService
extends AbstractLifecycleComponent
```
Interface for Circuit Breaker services, which provide breakers to classes that load field data.

Field Summary
- Fields inherited from class org.elasticsearch.common.component.AbstractLifecycleComponent
  lifecycle

Constructor Summary

Constructors
Modifier Constructor Description

protected CircuitBreakerService(Settings settings)

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`doClose()`
`protected void`	`doStart()`
`protected void`	`doStop()`
`abstract CircuitBreaker`	`getBreaker(java.lang.String name)`
`abstract void`	`registerBreaker(BreakerSettings breakerSettings)`	Allows to register of a custom circuit breaker.
`abstract AllCircuitBreakerStats`	`stats()`
`abstract CircuitBreakerStats`	`stats(java.lang.String name)`

Methods inherited from class org.elasticsearch.common.component.AbstractLifecycleComponent
addLifecycleListener, close, lifecycleState, removeLifecycleListener, start, stop

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

- Constructor Detail
  - CircuitBreakerService
```
protected CircuitBreakerService(Settings settings)
```
- Method Detail
  - registerBreaker
```
public abstract void registerBreaker(BreakerSettings breakerSettings)
```
    Allows to register of a custom circuit breaker.
  - getBreaker
```
public abstract CircuitBreaker getBreaker(java.lang.String name)
```
    Returns:
    
    the breaker that can be used to register estimates against
  - stats
```
public abstract AllCircuitBreakerStats stats()
```
    Returns:
    
    stats about all breakers
  - stats
```
public abstract CircuitBreakerStats stats(java.lang.String name)
```
    Returns:
    
    stats about a specific breaker
  - doStart
```
protected void doStart()
```
    Specified by:
    
    doStart in class AbstractLifecycleComponent
  - doStop
```
protected void doStop()
```
    Specified by:
    
    doStop in class AbstractLifecycleComponent
  - doClose
```
protected void doClose()
```
    Specified by:
    
    doClose in class AbstractLifecycleComponent