Module org.elasticsearch.server

Package org.elasticsearch.repositories.blobstore

Record Class IndexShardCount

java.lang.Object

java.lang.Record

org.elasticsearch.repositories.blobstore.IndexShardCount

public record IndexShardCount(int count)
extends Record

A subset of IndexMetadata storing only the shard count of an index

Constructor Summary

Constructors

Constructor	Description
IndexShardCount(int count)	Creates an instance of a IndexShardCount record class.

Method Summary

Modifier and Type	Method	Description
int	count()	Returns the value of the count record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static IndexShardCount	fromIndexMetadata(XContentParser parser)	Parses an IndexMetadata object, reading only the shard count and skipping the rest.
final int	hashCode()	Returns a hash code value for this object.
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

IndexShardCount

public IndexShardCount(int count)

Creates an instance of a IndexShardCount record class.

Parameters:

count - the value for the count record component

Method Details

fromIndexMetadata

public static IndexShardCount fromIndexMetadata(XContentParser parser)
                                         throws IOException

Parses an IndexMetadata object, reading only the shard count and skipping the rest. Assumes that the settings object is flat, and not nested.

Parameters:

parser - The parser of the IndexMetadata object

Returns:

Returns an IndexShardCount containing the shard count for the index

Throws:

IOException - Thrown if the IndexMetadata object cannot be parsed correctly

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.

count

public int count()

Returns the value of the count record component.

Returns:

the value of the count record component