Package org.elasticsearch.index.engine

Class CommitStats

java.lang.Object

org.elasticsearch.index.engine.CommitStats

All Implemented Interfaces:

Streamable, ToXContent, ToXContentFragment

public final class CommitStats
extends java.lang.Object
implements Streamable, ToXContentFragment

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	Description
CommitStats(org.apache.lucene.index.SegmentInfos segmentInfos)

Method Summary

Modifier and Type	Method	Description
long	getGeneration()
java.lang.String	getId()	base64 version of the commit id (see SegmentInfos.getId()
int	getNumDocs()	Returns the number of documents in the in this commit
Engine.CommitId	getRawCommitId()	A raw version of the commit id (see SegmentInfos.getId()
java.util.Map<java.lang.String,java.lang.String>	getUserData()
void	readFrom(StreamInput in)	Set this object's fields from a StreamInput.
static CommitStats	readOptionalCommitStatsFrom(StreamInput in)
java.lang.String	syncId()	The synced-flush id of the commit if existed.
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

CommitStats

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

Method Detail

readOptionalCommitStatsFrom

public static CommitStats readOptionalCommitStatsFrom(StreamInput in)
                                               throws java.io.IOException

Throws:

java.io.IOException

getUserData

public java.util.Map<java.lang.String,java.lang.String> getUserData()

getGeneration

public long getGeneration()

getId

public java.lang.String getId()

base64 version of the commit id (see SegmentInfos.getId()

getRawCommitId

public Engine.CommitId getRawCommitId()

A raw version of the commit id (see SegmentInfos.getId()

syncId

public java.lang.String syncId()

The synced-flush id of the commit if existed.

getNumDocs

public int getNumDocs()

Returns the number of documents in the in this commit

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 interface Streamable

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 interface Streamable

Throws:

java.io.IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException