Package org.opensearch.indices.breaker

Class BreakerSettings

java.lang.Object

org.opensearch.indices.breaker.BreakerSettings

public final class BreakerSettings
extends Object

Settings for a CircuitBreaker

Opensearch.internal:

Field Summary

Fields

Modifier and Type	Field	Description
static final Setting.AffixSetting<org.opensearch.core.common.unit.ByteSizeValue>	CIRCUIT_BREAKER_LIMIT_SETTING
static final Setting.AffixSetting<Double>	CIRCUIT_BREAKER_OVERHEAD_SETTING
static final Setting.AffixSetting<org.opensearch.core.common.breaker.CircuitBreaker.Type>	CIRCUIT_BREAKER_TYPE

Constructor Summary

Constructors

Constructor	Description
BreakerSettings(String name, long limitBytes, double overhead)
BreakerSettings(String name, long limitBytes, double overhead, org.opensearch.core.common.breaker.CircuitBreaker.Type type, org.opensearch.core.common.breaker.CircuitBreaker.Durability durability)

Method Summary

Modifier and Type	Method	Description
org.opensearch.core.common.breaker.CircuitBreaker.Durability	getDurability()
long	getLimit()
String	getName()
double	getOverhead()
org.opensearch.core.common.breaker.CircuitBreaker.Type	getType()
String	toString()
static BreakerSettings	updateFromSettings(BreakerSettings defaultSettings, Settings currentSettings)

Methods inherited from class java.lang.Object

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

Field Details

CIRCUIT_BREAKER_LIMIT_SETTING

public static final Setting.AffixSetting<org.opensearch.core.common.unit.ByteSizeValue> CIRCUIT_BREAKER_LIMIT_SETTING

CIRCUIT_BREAKER_OVERHEAD_SETTING

public static final Setting.AffixSetting<Double> CIRCUIT_BREAKER_OVERHEAD_SETTING

CIRCUIT_BREAKER_TYPE

public static final Setting.AffixSetting<org.opensearch.core.common.breaker.CircuitBreaker.Type> CIRCUIT_BREAKER_TYPE

Constructor Details

BreakerSettings

public BreakerSettings(String name,
 long limitBytes,
 double overhead)

BreakerSettings

public BreakerSettings(String name,
 long limitBytes,
 double overhead,
 org.opensearch.core.common.breaker.CircuitBreaker.Type type,
 org.opensearch.core.common.breaker.CircuitBreaker.Durability durability)

Method Details

updateFromSettings

public static BreakerSettings updateFromSettings(BreakerSettings defaultSettings,
 Settings currentSettings)

getName

public String getName()

getLimit

public long getLimit()

getOverhead

public double getOverhead()

getType

public org.opensearch.core.common.breaker.CircuitBreaker.Type getType()

getDurability

public org.opensearch.core.common.breaker.CircuitBreaker.Durability getDurability()

toString

public String toString()

Overrides:

toString in class Object