com.arakelian.elastic.model.enums

Enum ExecutionHint

java.lang.Object

java.lang.Enum<ExecutionHint>

com.arakelian.elastic.model.enums.ExecutionHint

All Implemented Interfaces:

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

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
GLOBAL_ORDINALS GLOBAL_ORDINALS is the default option for keyword fields, it uses global ordinals to allocates buckets dynamically so memory usage is linear to the number of values of the documents that are part of the aggregation scope.
MAP MAP should only be considered when very few documents match a query.

Method Summary

Modifier and Type	Method and Description
static ExecutionHint	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ExecutionHint[]	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

GLOBAL_ORDINALS

public static final ExecutionHint GLOBAL_ORDINALS

GLOBAL_ORDINALS is the default option for keyword fields, it uses global ordinals to allocates buckets dynamically so memory usage is linear to the number of values of the documents that are part of the aggregation scope.

MAP

public static final ExecutionHint MAP

MAP should only be considered when very few documents match a query. Otherwise the ordinals-based execution mode is significantly faster. By default, map is only used when running an aggregation on scripts, since they don’t have ordinals.

Method Detail

values

public static ExecutionHint[] 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 (ExecutionHint c : ExecutionHint.values())
    System.out.println(c);

Returns:

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

valueOf

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