Module org.elasticsearch.server

Package org.elasticsearch.cluster

Record Class ClusterInfo.ReservedSpace

java.lang.Object

java.lang.Record

org.elasticsearch.cluster.ClusterInfo.ReservedSpace

All Implemented Interfaces:

Writeable

Enclosing class:

ClusterInfo

public static record ClusterInfo.ReservedSpace(long total, Set<ShardId> shardIds)
extends Record
implements Writeable

Represents the total amount of "reserved" space on a particular data path, together with the set of shards considered.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ClusterInfo.ReservedSpace.Builder

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final ClusterInfo.ReservedSpace	EMPTY

Constructor Summary

Constructors

Constructor	Description
ReservedSpace(long total, Set<ShardId> shardIds)	Creates an instance of a ReservedSpace record class.

Method Summary

Modifier and Type	Method	Description
boolean	containsShardId(ShardId shardId)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
long	getTotal()
final int	hashCode()	Returns a hash code value for this object.
Set<ShardId>	shardIds()	Returns the value of the shardIds record component.
final String	toString()	Returns a string representation of this record class.
long	total()	Returns the value of the total 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

Field Details

EMPTY

public static final ClusterInfo.ReservedSpace EMPTY

Constructor Details

ReservedSpace

public ReservedSpace(long total,
 Set<ShardId> shardIds)

Creates an instance of a ReservedSpace record class.

Parameters:

total - the value for the total record component

shardIds - the value for the shardIds 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

getTotal

public long getTotal()

containsShardId

public boolean containsShardId(ShardId shardId)

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. Reference components are compared with Objects::equals(Object,Object); primitive components 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 long total()

Returns the value of the total record component.

Returns:

the value of the total record component

shardIds

public Set<ShardId> shardIds()

Returns the value of the shardIds record component.

Returns:

the value of the shardIds record component