org.elasticsearch.search.profile

Class CollectorResult

java.lang.Object

org.elasticsearch.search.profile.CollectorResult

All Implemented Interfaces:

StreamableReader, Writeable, ToXContent

public class CollectorResult
extends Object
implements ToXContent, Writeable

Public interface and serialization container for profiled timings of the Collectors used in the search. Children CollectorResult's may be embedded inside of a parent CollectorResult

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field and Description
static String	REASON_AGGREGATION
static String	REASON_AGGREGATION_GLOBAL
static String	REASON_SEARCH_COUNT
static String	REASON_SEARCH_MIN_SCORE
static String	REASON_SEARCH_MULTI
static String	REASON_SEARCH_POST_FILTER
static String	REASON_SEARCH_TERMINATE_AFTER_COUNT
static String	REASON_SEARCH_TIMEOUT
static String	REASON_SEARCH_TOP_HITS

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
CollectorResult(StreamInput in)
CollectorResult(String collectorName, String reason, Long time, List<CollectorResult> children)

Method Summary

Methods

Modifier and Type	Method and Description
String	getName()
List<CollectorResult>	getProfiledChildren()
String	getReason()
long	getTime()
Object	readFrom(StreamInput in) Reads a copy of an object with the same type form the stream input The caller object remains unchanged.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out) Writes the current object into the output stream out

Methods inherited from class java.lang.Object

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

Field Detail

REASON_SEARCH_COUNT

public static final String REASON_SEARCH_COUNT

See Also:

Constant Field Values

REASON_SEARCH_TOP_HITS

public static final String REASON_SEARCH_TOP_HITS

See Also:

Constant Field Values

REASON_SEARCH_TERMINATE_AFTER_COUNT

public static final String REASON_SEARCH_TERMINATE_AFTER_COUNT

See Also:

Constant Field Values

REASON_SEARCH_POST_FILTER

public static final String REASON_SEARCH_POST_FILTER

See Also:

Constant Field Values

REASON_SEARCH_MIN_SCORE

public static final String REASON_SEARCH_MIN_SCORE

See Also:

Constant Field Values

REASON_SEARCH_MULTI

public static final String REASON_SEARCH_MULTI

See Also:

Constant Field Values

REASON_SEARCH_TIMEOUT

public static final String REASON_SEARCH_TIMEOUT

See Also:

Constant Field Values

REASON_AGGREGATION

public static final String REASON_AGGREGATION

See Also:

Constant Field Values

REASON_AGGREGATION_GLOBAL

public static final String REASON_AGGREGATION_GLOBAL

See Also:

Constant Field Values

Constructor Detail

CollectorResult

public CollectorResult(String collectorName,
               String reason,
               Long time,
               List<CollectorResult> children)

CollectorResult

public CollectorResult(StreamInput in)
                throws IOException

Throws:

IOException

Method Detail

getTime

public long getTime()

Returns:

the profiled time for this collector (inclusive of children)

getReason

public String getReason()

Returns:

a human readable "hint" about what this collector was used for

getName

public String getName()

Returns:

the lucene class name of the collector

getProfiledChildren

public List<CollectorResult> getProfiledChildren()

Returns:

a list of children collectors

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Writes the current object into the output stream out

Specified by:

writeTo in interface Writeable

Throws:

IOException

readFrom

public Object readFrom(StreamInput in)
                throws IOException

Description copied from interface: StreamableReader

Reads a copy of an object with the same type form the stream input The caller object remains unchanged.

Specified by:

readFrom in interface StreamableReader

Throws:

IOException