com.arakelian.elastic.model.enums

Enum CollectMode

java.lang.Object

java.lang.Enum<CollectMode>

com.arakelian.elastic.model.enums.CollectMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CollectMode>

public enum CollectMode
extends java.lang.Enum<CollectMode>

Deferring calculation of child aggregations For fields with many unique terms and a small number of required results it can be more efficient to delay the calculation of child aggregations until the top parent-level aggs have been pruned. Ordinarily, all branches of the aggregation tree are expanded in one depth-first pass and only then any pruning occurs. In some scenarios this can be very wasteful and can hit memory constraints.

See Also:

Collect Mode

Enum Constant Summary

Enum Constants

Enum Constant and Description
BREADTH_FIRST
DEPTH_FIRST

Method Summary

Modifier and Type	Method and Description
static CollectMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CollectMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BREADTH_FIRST

public static final CollectMode BREADTH_FIRST

DEPTH_FIRST

public static final CollectMode DEPTH_FIRST

Method Detail

values

public static CollectMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CollectMode c : CollectMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CollectMode 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