Module org.elasticsearch.server
Record Class NodeAllocationStats
java.lang.Object
java.lang.Record
org.elasticsearch.cluster.routing.allocation.NodeAllocationStats
- Record Components:
shards- count of shards on this node.undesiredShards- count of shards that we want to move off of this node.forecastedIngestLoad- the predicted near future total ingest load on this node.forecastedDiskUsage- the predicted near future total disk usage on this node.currentDiskUsage- the current total disk usage on this node.
- All Implemented Interfaces:
Writeable,ToXContent,ToXContentFragment
public record NodeAllocationStats(int shards, int undesiredShards, double forecastedIngestLoad, long forecastedDiskUsage, long currentDiskUsage)
extends Record
implements Writeable, ToXContentFragment
Point-in-time allocation stats for a particular node.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.ParamsNested 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
ConstructorsConstructorDescriptionNodeAllocationStats(int shards, int undesiredShards, double forecastedIngestLoad, long forecastedDiskUsage, long currentDiskUsage) Creates an instance of aNodeAllocationStatsrecord class. -
Method Summary
Modifier and TypeMethodDescriptionlongReturns the value of thecurrentDiskUsagerecord component.final booleanIndicates whether some other object is "equal to" this one.longReturns the value of theforecastedDiskUsagerecord component.doubleReturns the value of theforecastedIngestLoadrecord component.final inthashCode()Returns a hash code value for this object.intshards()Returns the value of theshardsrecord component.final StringtoString()Returns a string representation of this record class.toXContent(XContentBuilder builder, ToXContent.Params params) intReturns the value of theundesiredShardsrecord component.voidwriteTo(StreamOutput out) Write this into the StreamOutput.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.xcontent.ToXContentFragment
isFragment
-
Constructor Details
-
NodeAllocationStats
- Throws:
IOException
-
NodeAllocationStats
public NodeAllocationStats(int shards, int undesiredShards, double forecastedIngestLoad, long forecastedDiskUsage, long currentDiskUsage) Creates an instance of aNodeAllocationStatsrecord class.- Parameters:
shards- the value for theshardsrecord componentundesiredShards- the value for theundesiredShardsrecord componentforecastedIngestLoad- the value for theforecastedIngestLoadrecord componentforecastedDiskUsage- the value for theforecastedDiskUsagerecord componentcurrentDiskUsage- the value for thecurrentDiskUsagerecord component
-
-
Method Details
-
writeTo
Description copied from interface:WriteableWrite this into the StreamOutput.- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
toXContentin interfaceToXContent- Throws:
IOException
-
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. -
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. -
equals
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 '=='. -
shards
public int shards()Returns the value of theshardsrecord component.- Returns:
- the value of the
shardsrecord component
-
undesiredShards
public int undesiredShards()Returns the value of theundesiredShardsrecord component.- Returns:
- the value of the
undesiredShardsrecord component
-
forecastedIngestLoad
public double forecastedIngestLoad()Returns the value of theforecastedIngestLoadrecord component.- Returns:
- the value of the
forecastedIngestLoadrecord component
-
forecastedDiskUsage
public long forecastedDiskUsage()Returns the value of theforecastedDiskUsagerecord component.- Returns:
- the value of the
forecastedDiskUsagerecord component
-
currentDiskUsage
public long currentDiskUsage()Returns the value of thecurrentDiskUsagerecord component.- Returns:
- the value of the
currentDiskUsagerecord component
-