Package org.elasticsearch.index.shard
Class DocsStats
- java.lang.Object
-
- org.elasticsearch.index.shard.DocsStats
-
- All Implemented Interfaces:
Streamable
,Writeable
,ToXContent
,ToXContentFragment
public class DocsStats extends java.lang.Object implements Streamable, Writeable, ToXContentFragment
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.elasticsearch.common.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 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.void
readFrom(StreamInput in)
Set this object's fields from a StreamInput.XContentBuilder
toXContent(XContentBuilder builder, ToXContent.Params params)
void
writeTo(StreamOutput out)
Write this object's fields to a 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 Detail
-
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 Detail
-
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 thanStoreStats.getSizeInBytes()
in estimating the index size.
-
getAverageSizeInBytes
public long getAverageSizeInBytes()
Returns the average size in bytes of all documents in this stats.
-
readFrom
public void readFrom(StreamInput in) throws java.io.IOException
Description copied from interface:Streamable
Set this object's fields from a StreamInput.- Specified by:
readFrom
in interfaceStreamable
- Throws:
java.io.IOException
-
writeTo
public void writeTo(StreamOutput out) throws java.io.IOException
Description copied from interface:Streamable
Write this object's fields to a StreamOutput.- Specified by:
writeTo
in interfaceStreamable
- Specified by:
writeTo
in interfaceWriteable
- Throws:
java.io.IOException
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
- Specified by:
toXContent
in interfaceToXContent
- Throws:
java.io.IOException
-
-