Class 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
    • Field Detail

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

        public static final java.lang.String REASON_SEARCH_TIMEOUT
        See Also:
        Constant Field Values
      • REASON_SEARCH_CANCELLED

        public static final java.lang.String REASON_SEARCH_CANCELLED
        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 Detail

      • CollectorResult

        public CollectorResult​(java.lang.String collectorName,
                               java.lang.String reason,
                               java.lang.Long time,
                               java.util.List<CollectorResult> children)
      • CollectorResult

        public CollectorResult​(StreamInput in)
                        throws java.io.IOException
        Read from a stream.
        Throws:
        java.io.IOException
    • Method Detail

      • 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

        public java.util.List<CollectorResult> getProfiledChildren()
        Returns:
        a list of children collectors