Module org.elasticsearch.server

Package org.elasticsearch.cluster.metadata

Record Class IndexMetadataStats

java.lang.Object

java.lang.Record

org.elasticsearch.cluster.metadata.IndexMetadataStats

All Implemented Interfaces:

Writeable, ToXContent, ToXContentFragment

public record IndexMetadataStats(IndexWriteLoad indexWriteLoad, IndexMetadataStats.AverageShardSize averageShardSize)
extends Record
implements Writeable, ToXContentFragment

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	IndexMetadataStats.AverageShardSize

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

Modifier and Type	Field	Description
static final ParseField	AVERAGE_SIZE_FIELD
static final ParseField	WRITE_LOAD_FIELD

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
IndexMetadataStats(IndexWriteLoad indexWriteLoad, long totalSizeInBytes, int numberOfShards)
IndexMetadataStats(IndexWriteLoad indexWriteLoad, IndexMetadataStats.AverageShardSize averageShardSize)	Creates an instance of a IndexMetadataStats record class.
IndexMetadataStats(StreamInput in)

Method Summary

Modifier and Type	Method	Description
IndexMetadataStats.AverageShardSize	averageShardSize()	Returns the value of the averageShardSize record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static IndexMetadataStats	fromStatsResponse(IndexMetadata indexMetadata, IndicesStatsResponse indicesStatsResponse)
static IndexMetadataStats	fromXContent(XContentParser parser)
final int	hashCode()	Returns a hash code value for this object.
IndexWriteLoad	indexWriteLoad()	Returns the value of the indexWriteLoad record component.
final String	toString()	Returns a string representation of this record class.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
IndexWriteLoad	writeLoad()
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

Field Details

WRITE_LOAD_FIELD

public static final ParseField WRITE_LOAD_FIELD

AVERAGE_SIZE_FIELD

public static final ParseField AVERAGE_SIZE_FIELD

Constructor Details

IndexMetadataStats

public IndexMetadataStats(IndexWriteLoad indexWriteLoad,
 long totalSizeInBytes,
 int numberOfShards)

IndexMetadataStats

public IndexMetadataStats(StreamInput in)
                   throws IOException

Throws:

IOException

IndexMetadataStats

public IndexMetadataStats(IndexWriteLoad indexWriteLoad,
 IndexMetadataStats.AverageShardSize averageShardSize)

Creates an instance of a IndexMetadataStats record class.

Parameters:

indexWriteLoad - the value for the indexWriteLoad record component

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

fromXContent

public static IndexMetadataStats fromXContent(XContentParser parser)
                                       throws IOException

Throws:

IOException

fromStatsResponse

@Nullable
public static IndexMetadataStats fromStatsResponse(IndexMetadata indexMetadata,
 @Nullable
 IndicesStatsResponse indicesStatsResponse)

writeLoad

public IndexWriteLoad writeLoad()

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.

indexWriteLoad

public IndexWriteLoad indexWriteLoad()

Returns the value of the indexWriteLoad record component.

Returns:

the value of the indexWriteLoad record component

averageShardSize

public IndexMetadataStats.AverageShardSize averageShardSize()

Returns the value of the averageShardSize record component.

Returns:

the value of the averageShardSize record component