Package org.elasticsearch.index.shard

Class DocsStats

java.lang.Object
org.elasticsearch.index.shard.DocsStats
All Implemented Interfaces:
Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment
public class DocsStats
extends java.lang.Object
implements Writeable, org.elasticsearch.common.xcontent.ToXContentFragment

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

    org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

    Nested 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.common.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors 
    Constructor Description
    DocsStats()  
    DocsStats​(long count, long deleted, long totalSizeInBytes)  
    DocsStats​(StreamInput in)  

  • Method Summary

    Modifier and Type Method Description
    void add​(DocsStats other)  
    long getAverageSizeInBytes()
    Returns the average size in bytes of all documents in this stats.
    long getCount()  
    long getDeleted()  
    long getTotalSizeInBytes()
    Returns the total size in bytes of all documents in this stats.
    org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)  
    void writeTo​(StreamOutput out)
    Write this into the StreamOutput.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

    isFragment

  • Constructor Details

    • DocsStats

      public DocsStats()

    • DocsStats

      public DocsStats​(StreamInput in) throws java.io.IOException
      Throws:
      java.io.IOException

    • DocsStats

      public DocsStats​(long count, long deleted, long totalSizeInBytes)

  • Method Details

    • add

      public void add​(DocsStats other)

    • getCount

      public long getCount()

    • getDeleted

      public long getDeleted()

    • getTotalSizeInBytes

      public long getTotalSizeInBytes()
      Returns the total size in bytes of all documents in this stats. This value may be more reliable than StoreStats.getSizeInBytes() in estimating the index size.

    • getAverageSizeInBytes

      public long getAverageSizeInBytes()
      Returns the average size in bytes of all documents in this stats.

    • writeTo

      public void writeTo​(StreamOutput out) throws java.io.IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      java.io.IOException

    • toXContent

      public org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      java.io.IOException