org.elasticsearch.index.suggest.stats

Class SuggestStats

java.lang.Object

org.elasticsearch.index.suggest.stats.SuggestStats

All Implemented Interfaces:

Streamable, ToXContent

public class SuggestStats
extends Object
implements Streamable, ToXContent

Exposes suggest related statistics.

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 and Description
SuggestStats()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(SuggestStats suggestStats)
long	getCount()
long	getCurrent()
TimeValue	getTime()
long	getTimeInMillis()
void	readFrom(StreamInput in)
static SuggestStats	readSuggestStats(StreamInput in)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Constructor Detail

SuggestStats

public SuggestStats()

Method Detail

getCount

public long getCount()

Returns:

The number of times the suggest api has been invoked.

getTimeInMillis

public long getTimeInMillis()

Returns:

The total amount of time spend in the suggest api

getTime

public TimeValue getTime()

Returns:

The total amount of time spend in the suggest api

getCurrent

public long getCurrent()

Returns:

The total amount of active suggest api invocations.

add

public void add(SuggestStats suggestStats)

readSuggestStats

public static SuggestStats readSuggestStats(StreamInput in)
                                     throws IOException

Throws:

IOException

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException