CommitStats

java.lang.Object
- org.elasticsearch.index.engine.CommitStats

All Implemented Interfaces:

Streamable, ToXContent
```
public final class CommitStats
extends Object
implements Streamable, ToXContent
```
a class the returns dynamic information with respect to the last commit point of this shard

Nested Class Summary
- Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
  ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary
- Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
  EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
`CommitStats(org.apache.lucene.index.SegmentInfos segmentInfos)`

Method Summary

All Methods

Static Methods

Instance Methods

Concrete Methods
Modifier and Type	Method and Description
`long`	`getGeneration()`
`int`	`getNumDocs()` Returns the number of documents in the in this commit
`Map<String,String>`	`getUserData()`
`void`	`readFrom(StreamInput in)`
`static CommitStats`	`readOptionalCommitStatsFrom(StreamInput in)`
`XContentBuilder`	`toXContent(XContentBuilder builder, ToXContent.Params params)`
`void`	`writeTo(StreamOutput out)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CommitStats

public CommitStats(org.apache.lucene.index.SegmentInfos segmentInfos)

Method Detail

readOptionalCommitStatsFrom

public static CommitStats readOptionalCommitStatsFrom(StreamInput in)
                                               throws IOException

Throws:: IOException

getUserData

public Map<String,String> getUserData()

getGeneration
```
public long getGeneration()
```

getNumDocs
```
public int getNumDocs()
```
Returns the number of documents in the in this commit

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:: readFrom in interface Streamable
Throws:: IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:: writeTo in interface Streamable
Throws:: IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws IOException

Specified by:: toXContent in interface ToXContent
Throws:: IOException

Class CommitStats

Nested Class Summary

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

Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

Constructor Summary

Constructors

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CommitStats

Method Detail

readOptionalCommitStatsFrom

getUserData

getGeneration

getNumDocs

readFrom

writeTo

toXContent