Package org.opensearch.index.search.stats

Class SearchStats

java.lang.Object

org.opensearch.index.search.stats.SearchStats

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 SearchStats
extends Object
implements org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContentFragment

Encapsulates stats for search time

Opensearch.api:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SearchStats.PhaseStatsLongHolder	Holds statistic values for a particular phase.
static class	SearchStats.RequestStatsLongHolder	Holds all requests stats.
static class	SearchStats.Stats	Holder of statistics values

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
SearchStats()
SearchStats(org.opensearch.core.common.io.stream.StreamInput in)
SearchStats(SearchStats.Stats totalStats, long openContexts, Map<String,SearchStats.Stats> groupStats)

Method Summary

Modifier and Type	Method	Description
void	add(SearchStats searchStats)
void	addTotals(SearchStats searchStats)
void	addTotalsForClosingShard(SearchStats searchStats)
Map<String,SearchStats.Stats>	getGroupStats()
long	getOpenContexts()
SearchStats.Stats	getTotal()
void	setSearchRequestStats(SearchRequestStats searchRequestStats)
String	toString()
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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

isFragment

Constructor Details

SearchStats

public SearchStats()

SearchStats

public SearchStats(SearchStats.Stats totalStats,
 long openContexts,
 @Nullable
 Map<String,SearchStats.Stats> groupStats)

SearchStats

public SearchStats(org.opensearch.core.common.io.stream.StreamInput in)
            throws IOException

Throws:

IOException

Method Details

setSearchRequestStats

public void setSearchRequestStats(SearchRequestStats searchRequestStats)

add

public void add(SearchStats searchStats)

addTotals

public void addTotals(SearchStats searchStats)

addTotalsForClosingShard

public void addTotalsForClosingShard(SearchStats searchStats)

getTotal

public SearchStats.Stats getTotal()

getOpenContexts

public long getOpenContexts()

getGroupStats

@Nullable
public Map<String,SearchStats.Stats> getGroupStats()

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

toString

public String toString()

Overrides:

toString in class Object

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