Package org.opensearch.index.refresh

Class RefreshStats

java.lang.Object
org.opensearch.index.refresh.RefreshStats
All Implemented Interfaces:
org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment
@PublicApi(since="1.0.0") public class RefreshStats extends Object implements org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContentFragment
Encapsulates stats for index refresh
Opensearch.api:

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

    org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

    Nested classes/interfaces inherited from interface org.opensearch.core.common.io.stream.Writeable

    org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

  • Field Summary

    Fields inherited from interface org.opensearch.core.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    RefreshStats()
     
    RefreshStats(long total, long totalTimeInMillis, long externalTotal, long externalTotalTimeInMillis, int listeners)
     
    RefreshStats(org.opensearch.core.common.io.stream.StreamInput in)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    add(RefreshStats refreshStats)
     
    void
    addTotals(RefreshStats refreshStats)
     
    boolean
    equals(Object obj)
     
    long
    getExternalTotal()
     
    org.opensearch.common.unit.TimeValue
    getExternalTotalTime()
    The total time external refreshes have been executed.
    long
    getExternalTotalTimeInMillis()
    The total time spent executing external refreshes (in milliseconds).
    int
    getListeners()
    The number of waiting refresh listeners.
    long
    getTotal()
    The total number of refresh executed.
    org.opensearch.common.unit.TimeValue
    getTotalTime()
    The total time refreshes have been executed.
    long
    getTotalTimeInMillis()
    The total time spent executing refreshes (in milliseconds).
    int
    hashCode()
     
    org.opensearch.core.xcontent.XContentBuilder
    toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
     
    void
    writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
     

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.opensearch.core.xcontent.ToXContentFragment

    isFragment

  • Constructor Details

    • RefreshStats

      public RefreshStats()

    • RefreshStats

      public RefreshStats(org.opensearch.core.common.io.stream.StreamInput in) throws IOException
      Throws:
      IOException

    • RefreshStats

      public RefreshStats(long total, long totalTimeInMillis, long externalTotal, long externalTotalTimeInMillis, int listeners)

  • Method Details

    • writeTo

      public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out) throws IOException
      Specified by:
      writeTo in interface org.opensearch.core.common.io.stream.Writeable
      Throws:
      IOException

    • add

      public void add(RefreshStats refreshStats)

    • addTotals

      public void addTotals(RefreshStats refreshStats)

    • getTotal

      public long getTotal()
      The total number of refresh executed.

    • getExternalTotal

      public long getExternalTotal()

    • getTotalTimeInMillis

      public long getTotalTimeInMillis()
      The total time spent executing refreshes (in milliseconds).

    • getExternalTotalTimeInMillis

      public long getExternalTotalTimeInMillis()
      The total time spent executing external refreshes (in milliseconds).

    • getTotalTime

      public org.opensearch.common.unit.TimeValue getTotalTime()
      The total time refreshes have been executed.

    • getExternalTotalTime

      public org.opensearch.common.unit.TimeValue getExternalTotalTime()
      The total time external refreshes have been executed.

    • getListeners

      public int getListeners()
      The number of waiting refresh listeners.

    • toXContent

      public org.opensearch.core.xcontent.XContentBuilder toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.opensearch.core.xcontent.ToXContent
      Throws:
      IOException

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object