Module org.elasticsearch.server

Package org.elasticsearch.action.admin.cluster.stats

Class SearchUsageStats

java.lang.Object

org.elasticsearch.action.admin.cluster.stats.SearchUsageStats

All Implemented Interfaces:

Writeable, ToXContent, ToXContentFragment

public final class SearchUsageStats
extends Object
implements Writeable, ToXContentFragment

Holds a snapshot of the search usage statistics. Used to hold the stats for a single node that's part of a ClusterStatsNodeResponse, as well as to accumulate stats for the entire cluster and return them as part of the ClusterStatsResponse.

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, 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, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
SearchUsageStats()	Creates a new empty stats instance, that will get additional stats added through add(SearchUsageStats)
SearchUsageStats(Map<String,Long> queries, Map<String,Long> sections, long totalSearchCount)	Creates a new stats instance with the provided info.
SearchUsageStats(StreamInput in)

Method Summary

Modifier and Type	Method	Description
void	add(SearchUsageStats stats)	Add the provided stats to the ones held by the current instance, effectively merging the two
boolean	equals(Object o)
Map<String,Long>	getQueryUsage()
Map<String,Long>	getSectionsUsage()
long	getTotalSearchCount()
int	hashCode()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Constructor Details

SearchUsageStats

public SearchUsageStats()

Creates a new empty stats instance, that will get additional stats added through add(SearchUsageStats)

SearchUsageStats

public SearchUsageStats(Map<String,Long> queries,
 Map<String,Long> sections,
 long totalSearchCount)

Creates a new stats instance with the provided info. The expectation is that when a new instance is created using this constructor, the provided stats are final and won't be modified further.

SearchUsageStats

public SearchUsageStats(StreamInput in)
                 throws IOException

Throws:

IOException

Method Details

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

add

public void add(SearchUsageStats stats)

Add the provided stats to the ones held by the current instance, effectively merging the two

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

getQueryUsage

public Map<String,Long> getQueryUsage()

getSectionsUsage

public Map<String,Long> getSectionsUsage()

getTotalSearchCount

public long getTotalSearchCount()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object