Module org.elasticsearch.server

Package org.elasticsearch.cluster.routing.allocation

Record Class NodeAllocationStats

java.lang.Object

java.lang.Record

org.elasticsearch.cluster.routing.allocation.NodeAllocationStats

All Implemented Interfaces:

Writeable, ToXContent, ToXContentFragment

public record NodeAllocationStats(int shards, int undesiredShards, double forecastedIngestLoad, long forecastedDiskUsage, long currentDiskUsage)
extends Record
implements Writeable, ToXContentFragment

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
NodeAllocationStats(int shards, int undesiredShards, double forecastedIngestLoad, long forecastedDiskUsage, long currentDiskUsage)	Creates an instance of a NodeAllocationStats record class.
NodeAllocationStats(StreamInput in)

Method Summary

Modifier and Type	Method	Description
long	currentDiskUsage()	Returns the value of the currentDiskUsage record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
long	forecastedDiskUsage()	Returns the value of the forecastedDiskUsage record component.
double	forecastedIngestLoad()	Returns the value of the forecastedIngestLoad record component.
final int	hashCode()	Returns a hash code value for this object.
int	shards()	Returns the value of the shards record component.
final String	toString()	Returns a string representation of this record class.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
int	undesiredShards()	Returns the value of the undesiredShards 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.ToXContentFragment

isFragment

Constructor Details

NodeAllocationStats

public NodeAllocationStats(StreamInput in)
                    throws IOException

Throws:

IOException

NodeAllocationStats

public NodeAllocationStats(int shards,
 int undesiredShards,
 double forecastedIngestLoad,
 long forecastedDiskUsage,
 long currentDiskUsage)

Creates an instance of a NodeAllocationStats record class.

Parameters:

shards - the value for the shards record component

undesiredShards - the value for the undesiredShards record component

forecastedIngestLoad - the value for the forecastedIngestLoad record component

forecastedDiskUsage - the value for the forecastedDiskUsage record component

currentDiskUsage - the value for the currentDiskUsage record component

Method Details

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.

shards

public int shards()

Returns the value of the shards record component.

Returns:

the value of the shards record component

undesiredShards

public int undesiredShards()

Returns the value of the undesiredShards record component.

Returns:

the value of the undesiredShards record component

forecastedIngestLoad

public double forecastedIngestLoad()

Returns the value of the forecastedIngestLoad record component.

Returns:

the value of the forecastedIngestLoad record component

forecastedDiskUsage

public long forecastedDiskUsage()

Returns the value of the forecastedDiskUsage record component.

Returns:

the value of the forecastedDiskUsage record component

currentDiskUsage

public long currentDiskUsage()

Returns the value of the currentDiskUsage record component.

Returns:

the value of the currentDiskUsage record component