Class AllCircuitBreakerStats
java.lang.Object
org.opensearch.core.indices.breaker.AllCircuitBreakerStats
- All Implemented Interfaces:
Writeable,ToXContent,ToXContentFragment
@PublicApi(since="1.0.0")
public class AllCircuitBreakerStats
extends Object
implements Writeable, ToXContentFragment
Stats class encapsulating all of the different circuit breaker stats
- Opensearch.api:
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.ParamsNested classes/interfaces inherited from interface org.opensearch.core.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.WriteableRegistry, Writeable.Writer<V> -
Field Summary
Fields inherited from interface org.opensearch.core.xcontent.ToXContent
EMPTY_PARAMS -
Constructor Summary
ConstructorsConstructorDescriptionConstructs the new instance fromStreamInputAllCircuitBreakerStats(CircuitBreakerStats[] allStats) Constructs the instance -
Method Summary
Modifier and TypeMethodDescriptionReturns inner stats instances for all circuit breakersReturns the stats for a specific circuit breakertoXContent(XContentBuilder builder, ToXContent.Params params) voidwriteTo(StreamOutput out) Writes this instance into aStreamOutputMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.core.xcontent.ToXContentFragment
isFragment
-
Constructor Details
-
AllCircuitBreakerStats
Constructs the instance- Parameters:
allStats- an array of all the circuit breaker stats
-
AllCircuitBreakerStats
Constructs the new instance fromStreamInput- Parameters:
in- theStreamInputto read from- Throws:
IOException- If an error occurs while reading from the StreamInput- See Also:
-
-
Method Details
-
writeTo
Writes this instance into aStreamOutput- Specified by:
writeToin interfaceWriteable- Parameters:
out- theStreamOutputto write to- Throws:
IOException- if an error occurs while writing to the StreamOutput
-
getAllStats
Returns inner stats instances for all circuit breakers- Returns:
- inner stats instances for all circuit breakers
-
getStats
Returns the stats for a specific circuit breaker- Parameters:
name- the name of the circuit breaker- Returns:
- the
CircuitBreakerStatsfor the circuit breaker, null if the circuit breaker with such name does not exist
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
toXContentin interfaceToXContent- Throws:
IOException
-