Module org.elasticsearch.server

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

Record Class ClusterBalanceStats.TierBalanceStats

java.lang.Object

java.lang.Record

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

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

Enclosing class:

ClusterBalanceStats

public static record ClusterBalanceStats.TierBalanceStats(ClusterBalanceStats.MetricStats shardCount, ClusterBalanceStats.MetricStats undesiredShardAllocations, ClusterBalanceStats.MetricStats forecastWriteLoad, ClusterBalanceStats.MetricStats forecastShardSize, ClusterBalanceStats.MetricStats actualShardSize)
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
TierBalanceStats(ClusterBalanceStats.MetricStats shardCount, ClusterBalanceStats.MetricStats undesiredShardAllocations, ClusterBalanceStats.MetricStats forecastWriteLoad, ClusterBalanceStats.MetricStats forecastShardSize, ClusterBalanceStats.MetricStats actualShardSize)	Creates an instance of a TierBalanceStats record class.

Method Summary

Modifier and Type	Method	Description
ClusterBalanceStats.MetricStats	actualShardSize()	Returns the value of the actualShardSize record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
ClusterBalanceStats.MetricStats	forecastShardSize()	Returns the value of the forecastShardSize record component.
ClusterBalanceStats.MetricStats	forecastWriteLoad()	Returns the value of the forecastWriteLoad record component.
final int	hashCode()	Returns a hash code value for this object.
static ClusterBalanceStats.TierBalanceStats	readFrom(StreamInput in)
ClusterBalanceStats.MetricStats	shardCount()	Returns the value of the shardCount record component.
final String	toString()	Returns a string representation of this record class.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
ClusterBalanceStats.MetricStats	undesiredShardAllocations()	Returns the value of the undesiredShardAllocations record component.
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

TierBalanceStats

public TierBalanceStats(ClusterBalanceStats.MetricStats shardCount,
 ClusterBalanceStats.MetricStats undesiredShardAllocations,
 ClusterBalanceStats.MetricStats forecastWriteLoad,
 ClusterBalanceStats.MetricStats forecastShardSize,
 ClusterBalanceStats.MetricStats actualShardSize)

Creates an instance of a TierBalanceStats record class.

Parameters:

shardCount - the value for the shardCount record component

undesiredShardAllocations - the value for the undesiredShardAllocations record component

forecastWriteLoad - the value for the forecastWriteLoad record component

forecastShardSize - the value for the forecastShardSize record component

actualShardSize - the value for the actualShardSize record component

Method Details

readFrom

public static ClusterBalanceStats.TierBalanceStats 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 Objects::equals(Object,Object).

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.

shardCount

public ClusterBalanceStats.MetricStats shardCount()

Returns the value of the shardCount record component.

Returns:

the value of the shardCount record component

undesiredShardAllocations

public ClusterBalanceStats.MetricStats undesiredShardAllocations()

Returns the value of the undesiredShardAllocations record component.

Returns:

the value of the undesiredShardAllocations record component

forecastWriteLoad

public ClusterBalanceStats.MetricStats forecastWriteLoad()

Returns the value of the forecastWriteLoad record component.

Returns:

the value of the forecastWriteLoad record component

forecastShardSize

public ClusterBalanceStats.MetricStats forecastShardSize()

Returns the value of the forecastShardSize record component.

Returns:

the value of the forecastShardSize record component

actualShardSize

public ClusterBalanceStats.MetricStats actualShardSize()

Returns the value of the actualShardSize record component.

Returns:

the value of the actualShardSize record component