Package org.elasticsearch.search.profile.query

Class CollectorResult

java.lang.Object

org.elasticsearch.search.profile.query.CollectorResult

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class CollectorResult
extends Object
implements ToXContentObject, 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

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

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static String	REASON_AGGREGATION
static String	REASON_AGGREGATION_GLOBAL
static String	REASON_SEARCH_CANCELLED
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	Description
CollectorResult(String collectorName, String reason, Long time, List<CollectorResult> children)
CollectorResult(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
static CollectorResult	fromXContent(XContentParser parser)
String	getName()
List<CollectorResult>	getProfiledChildren()
String	getReason()
long	getTime()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

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_SEARCH_CANCELLED

public static final String REASON_SEARCH_CANCELLED

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

Read from a stream.

Throws:

IOException

Method Detail

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

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

fromXContent

public static CollectorResult fromXContent(XContentParser parser)
                                    throws IOException

Throws:

IOException