Package org.elasticsearch.search.aggregations

Enum Aggregator.SubAggCollectionMode

java.lang.Object
java.lang.Enum<Aggregator.SubAggCollectionMode>
org.elasticsearch.search.aggregations.Aggregator.SubAggCollectionMode
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Aggregator.SubAggCollectionMode>, java.lang.constant.Constable, Writeable
Enclosing class:
Aggregator
public static enum Aggregator.SubAggCollectionMode
extends java.lang.Enum<Aggregator.SubAggCollectionMode>
implements Writeable
Aggregation mode for sub aggregations.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

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

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

  • Enum Constant Summary

    Enum Constants
    Enum Constant Description
    BREADTH_FIRST
    Creates buckets for all matching docs and then prunes to top-scoring buckets before a second pass over the data when child aggregators are called but only for docs from the top-scoring buckets
    DEPTH_FIRST
    Creates buckets and delegates to child aggregators in a single pass over the matching documents

  • Field Summary

    Fields
    Modifier and Type Field Description
    static org.elasticsearch.common.ParseField KEY  

  • Method Summary

    Modifier and Type Method Description
    static Aggregator.SubAggCollectionMode parse​(java.lang.String value, org.elasticsearch.common.xcontent.DeprecationHandler deprecationHandler)  
    org.elasticsearch.common.ParseField parseField()  
    static Aggregator.SubAggCollectionMode readFromStream​(StreamInput in)  
    static Aggregator.SubAggCollectionMode valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static Aggregator.SubAggCollectionMode[] values()
    Returns an array containing the constants of this enum type, in the order they are declared.
    void writeTo​(StreamOutput out)
    Write this into the StreamOutput.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • DEPTH_FIRST

      public static final Aggregator.SubAggCollectionMode DEPTH_FIRST
      Creates buckets and delegates to child aggregators in a single pass over the matching documents

    • BREADTH_FIRST

      public static final Aggregator.SubAggCollectionMode BREADTH_FIRST
      Creates buckets for all matching docs and then prunes to top-scoring buckets before a second pass over the data when child aggregators are called but only for docs from the top-scoring buckets

  • Field Details

    • KEY

      public static final org.elasticsearch.common.ParseField KEY

  • Method Details

    • values

      public static Aggregator.SubAggCollectionMode[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static Aggregator.SubAggCollectionMode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
      java.lang.NullPointerException - if the argument is null

    • parseField

      public org.elasticsearch.common.ParseField parseField()

    • parse

      public static Aggregator.SubAggCollectionMode parse​(java.lang.String value, org.elasticsearch.common.xcontent.DeprecationHandler deprecationHandler)

    • readFromStream

      public static Aggregator.SubAggCollectionMode readFromStream​(StreamInput in) throws java.io.IOException
      Throws:
      java.io.IOException

    • writeTo

      public void writeTo​(StreamOutput out) throws java.io.IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      java.io.IOException