Package org.opensearch.core.indices.breaker

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.Params

Nested 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

Constructors

Constructor	Description
AllCircuitBreakerStats(StreamInput in)	Constructs the new instance from StreamInput
AllCircuitBreakerStats(CircuitBreakerStats[] allStats)	Constructs the instance

Method Summary

Modifier and Type	Method	Description
CircuitBreakerStats[]	getAllStats()	Returns inner stats instances for all circuit breakers
CircuitBreakerStats	getStats(String name)	Returns the stats for a specific circuit breaker
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Writes this instance into a StreamOutput

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.core.xcontent.ToXContentFragment

isFragment

Constructor Details

AllCircuitBreakerStats

public AllCircuitBreakerStats(CircuitBreakerStats[] allStats)

Constructs the instance

Parameters:

allStats - an array of all the circuit breaker stats

AllCircuitBreakerStats

public AllCircuitBreakerStats(StreamInput in)
                       throws IOException

Constructs the new instance from StreamInput

Parameters:

in - the StreamInput to read from

Throws:

IOException - If an error occurs while reading from the StreamInput

See Also:

• writeTo(StreamOutput)

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Writes this instance into a StreamOutput

Specified by:

writeTo in interface Writeable

Parameters:

out - the StreamOutput to write to

Throws:

IOException - if an error occurs while writing to the StreamOutput

getAllStats

public CircuitBreakerStats[] getAllStats()

Returns inner stats instances for all circuit breakers

Returns:

inner stats instances for all circuit breakers

getStats

public CircuitBreakerStats getStats(String name)

Returns the stats for a specific circuit breaker

Parameters:

name - the name of the circuit breaker

Returns:

the CircuitBreakerStats for 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:

toXContent in interface ToXContent

Throws:

IOException