Module org.elasticsearch.server

Package org.elasticsearch.search.profile.query

Class CollectorResult

java.lang.Object

org.apache.lucene.sandbox.search.ProfilerCollectorResult

org.elasticsearch.search.profile.query.CollectorResult

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class CollectorResult
extends org.apache.lucene.sandbox.search.ProfilerCollectorResult
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.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 final String	REASON_AGGREGATION
static final String	REASON_AGGREGATION_GLOBAL
static final String	REASON_SEARCH_COUNT
static final String	REASON_SEARCH_MULTI
static final String	REASON_SEARCH_QUERY_PHASE
static final String	REASON_SEARCH_TOP_HITS

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, 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
boolean	equals(Object obj)
static CollectorResult	fromXContent(XContentParser parser)
List<CollectorResult>	getChildrenResults()	Exposes a list of children collector results.
int	hashCode()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.apache.lucene.sandbox.search.ProfilerCollectorResult

getName, getProfiledChildren, getReason, getTime

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

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_MULTI

public static final String REASON_SEARCH_MULTI

See Also:

• Constant Field Values

REASON_SEARCH_QUERY_PHASE

public static final String REASON_SEARCH_QUERY_PHASE

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 Details

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 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

getChildrenResults

public List<CollectorResult> getChildrenResults()

Exposes a list of children collector results. Same as ProfilerCollectorResult.getProfiledChildren() with each item in the list being cast to a CollectorResult

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

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