Module org.elasticsearch.server
Package org.elasticsearch.cluster.metadata

Record Class IndexMetadataStats.AverageShardSize

java.lang.Object
java.lang.Record
org.elasticsearch.cluster.metadata.IndexMetadataStats.AverageShardSize
All Implemented Interfaces:
Writeable, ToXContent, ToXContentFragment
Enclosing class:
IndexMetadataStats
public static record IndexMetadataStats.AverageShardSize(long totalSizeInBytes, int numberOfShards) extends Record implements Writeable, ToXContentFragment

  • Field Details

    • TOTAL_SIZE_IN_BYTES_FIELD

      public static final ParseField TOTAL_SIZE_IN_BYTES_FIELD

    • SHARD_COUNT_FIELD

      public static final ParseField SHARD_COUNT_FIELD

  • Constructor Details

    • AverageShardSize

      public AverageShardSize(long totalSizeInBytes, int numberOfShards)
      Creates an instance of a AverageShardSize record class.
      Parameters:
      totalSizeInBytes - the value for the totalSizeInBytes record component
      numberOfShards - the value for the numberOfShards 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

    • getAverageSizeInBytes

      public long getAverageSizeInBytes()

    • 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.

    • totalSizeInBytes

      public long totalSizeInBytes()
      Returns the value of the totalSizeInBytes record component.
      Returns:
      the value of the totalSizeInBytes record component

    • numberOfShards

      public int numberOfShards()
      Returns the value of the numberOfShards record component.
      Returns:
      the value of the numberOfShards record component