Package org.elasticsearch.index.engine

Class CommitStats

java.lang.Object
org.elasticsearch.index.engine.CommitStats
All Implemented Interfaces:
Writeable, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentFragment
public final class CommitStats extends Object implements Writeable, org.elasticsearch.xcontent.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.xcontent.ToXContent

    org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.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.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()
     
    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()
    Map<String,String>
    getUserData()
     
    static CommitStats
    readOptionalCommitStatsFrom(StreamInput in)
     
    String
    syncId()
    The synced-flush id of the commit if existed.
    org.elasticsearch.xcontent.XContentBuilder
    toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.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.xcontent.ToXContentFragment

    isFragment

  • Constructor Details

    • CommitStats

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

  • Method Details

    • readOptionalCommitStatsFrom

      public static CommitStats readOptionalCommitStatsFrom(StreamInput in) throws IOException
      Throws:
      IOException

    • getUserData

      public Map<String,String> getUserData()

    • getGeneration

      public long getGeneration()

    • getId

      public 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 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

    • 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 org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.elasticsearch.xcontent.ToXContent
      Throws:
      IOException