Module org.elasticsearch.server

Package org.elasticsearch.cluster.routing.allocation.allocator

Record Class ClusterBalanceStats.MetricStats

java.lang.Object

java.lang.Record

org.elasticsearch.cluster.routing.allocation.allocator.ClusterBalanceStats.MetricStats

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

Enclosing class:

ClusterBalanceStats

public static record ClusterBalanceStats.MetricStats(double total, double min, double max, double average, double stdDev)
extends Record
implements Writeable, ToXContentObject

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
MetricStats(double total, double min, double max, double average, double stdDev)	Creates an instance of a MetricStats record class.

Method Summary

Modifier and Type	Method	Description
double	average()	Returns the value of the average record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
double	max()	Returns the value of the max record component.
double	min()	Returns the value of the min record component.
static ClusterBalanceStats.MetricStats	readFrom(StreamInput in)
double	stdDev()	Returns the value of the stdDev record component.
final String	toString()	Returns a string representation of this record class.
double	total()	Returns the value of the total record component.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Constructor Details

MetricStats

public MetricStats(double total,
 double min,
 double max,
 double average,
 double stdDev)

Creates an instance of a MetricStats record class.

Parameters:

total - the value for the total record component

min - the value for the min record component

max - the value for the max record component

average - the value for the average record component

stdDev - the value for the stdDev record component

Method Details

readFrom

public static ClusterBalanceStats.MetricStats readFrom(StreamInput in)
                                                throws IOException

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

total

public double total()

Returns the value of the total record component.

Returns:

the value of the total record component

min

public double min()

Returns the value of the min record component.

Returns:

the value of the min record component

max

public double max()

Returns the value of the max record component.

Returns:

the value of the max record component

average

public double average()

Returns the value of the average record component.

Returns:

the value of the average record component

stdDev

public double stdDev()

Returns the value of the stdDev record component.

Returns:

the value of the stdDev record component