Class CollectorResult
java.lang.Object
org.elasticsearch.search.profile.query.CollectorResult
- All Implemented Interfaces:
Writeable
,ToXContent
,ToXContentObject
public class CollectorResult extends java.lang.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 java.lang.String
REASON_AGGREGATION
static java.lang.String
REASON_AGGREGATION_GLOBAL
static java.lang.String
REASON_SEARCH_COUNT
static java.lang.String
REASON_SEARCH_MIN_SCORE
static java.lang.String
REASON_SEARCH_MULTI
static java.lang.String
REASON_SEARCH_POST_FILTER
static java.lang.String
REASON_SEARCH_TERMINATE_AFTER_COUNT
static java.lang.String
REASON_SEARCH_TOP_HITS
-
Constructor Summary
Constructors Constructor Description CollectorResult(java.lang.String collectorName, java.lang.String reason, java.lang.Long time, java.util.List<CollectorResult> children)
CollectorResult(StreamInput in)
Read from a stream. -
Method Summary
Modifier and Type Method Description static CollectorResult
fromXContent(XContentParser parser)
java.lang.String
getName()
java.util.List<CollectorResult>
getProfiledChildren()
java.lang.String
getReason()
long
getTime()
XContentBuilder
toXContent(XContentBuilder builder, ToXContent.Params params)
void
writeTo(StreamOutput out)
Write this into the StreamOutput.
-
Field Details
-
REASON_SEARCH_COUNT
public static final java.lang.String REASON_SEARCH_COUNT- See Also:
- Constant Field Values
-
REASON_SEARCH_TOP_HITS
public static final java.lang.String REASON_SEARCH_TOP_HITS- See Also:
- Constant Field Values
-
REASON_SEARCH_TERMINATE_AFTER_COUNT
public static final java.lang.String REASON_SEARCH_TERMINATE_AFTER_COUNT- See Also:
- Constant Field Values
-
REASON_SEARCH_POST_FILTER
public static final java.lang.String REASON_SEARCH_POST_FILTER- See Also:
- Constant Field Values
-
REASON_SEARCH_MIN_SCORE
public static final java.lang.String REASON_SEARCH_MIN_SCORE- See Also:
- Constant Field Values
-
REASON_SEARCH_MULTI
public static final java.lang.String REASON_SEARCH_MULTI- See Also:
- Constant Field Values
-
REASON_AGGREGATION
public static final java.lang.String REASON_AGGREGATION- See Also:
- Constant Field Values
-
REASON_AGGREGATION_GLOBAL
public static final java.lang.String REASON_AGGREGATION_GLOBAL- See Also:
- Constant Field Values
-
-
Constructor Details
-
CollectorResult
public CollectorResult(java.lang.String collectorName, java.lang.String reason, java.lang.Long time, java.util.List<CollectorResult> children) -
CollectorResult
Read from a stream.- Throws:
java.io.IOException
-
-
Method Details
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput. -
getTime
public long getTime()- Returns:
- the profiled time for this collector (inclusive of children)
-
getReason
public java.lang.String getReason()- Returns:
- a human readable "hint" about what this collector was used for
-
getName
public java.lang.String getName()- Returns:
- the lucene class name of the collector
-
getProfiledChildren
- Returns:
- a list of children collectors
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceToXContent
- Throws:
java.io.IOException
-
fromXContent
- Throws:
java.io.IOException
-