Module org.elasticsearch.server

Package org.elasticsearch.cluster

Record Class ShardHeapUsageEstimates

java.lang.Object

java.lang.Record

org.elasticsearch.cluster.ShardHeapUsageEstimates

public record ShardHeapUsageEstimates(Map<ShardId,ShardAndIndexHeapUsage> perShard, ShardAndIndexHeapUsage defaultForShardsWithoutMetrics)
extends Record

Per-shard heap usage estimates from an EstimatedHeapUsageCollector, plus a default for any shard that has no entry in perShard().

Constructor Summary

Constructors

Constructor	Description
ShardHeapUsageEstimates(Map<ShardId,ShardAndIndexHeapUsage> perShard, ShardAndIndexHeapUsage defaultForShardsWithoutMetrics)	Creates an instance of a ShardHeapUsageEstimates record class.

Method Summary

Modifier and Type	Method	Description
ShardAndIndexHeapUsage	defaultForShardsWithoutMetrics()	Returns the value of the defaultForShardsWithoutMetrics record component.
static ShardHeapUsageEstimates	empty()
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.
Map<ShardId,ShardAndIndexHeapUsage>	perShard()	Returns the value of the perShard record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

ShardHeapUsageEstimates

public ShardHeapUsageEstimates(Map<ShardId,ShardAndIndexHeapUsage> perShard,
 ShardAndIndexHeapUsage defaultForShardsWithoutMetrics)

Creates an instance of a ShardHeapUsageEstimates record class.

Parameters:

perShard - the value for the perShard record component

defaultForShardsWithoutMetrics - the value for the defaultForShardsWithoutMetrics record component

Method Details

empty

public static ShardHeapUsageEstimates empty()

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.

perShard

public Map<ShardId,ShardAndIndexHeapUsage> perShard()

Returns the value of the perShard record component.

Returns:

the value of the perShard record component

defaultForShardsWithoutMetrics

public ShardAndIndexHeapUsage defaultForShardsWithoutMetrics()

Returns the value of the defaultForShardsWithoutMetrics record component.

Returns:

the value of the defaultForShardsWithoutMetrics record component