Package org.elasticsearch.search.aggregations

Enum CardinalityUpperBound

java.lang.Object

java.lang.Enum<CardinalityUpperBound>

org.elasticsearch.search.aggregations.CardinalityUpperBound

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CardinalityUpperBound>, java.lang.constant.Constable

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

Upper bound of how many owningBucketOrds that an Aggregator will have to collect into. Just "none", "one", and "many".

Nested Class Summary

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

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

Enum Constant Summary

Enum Constants

Enum Constant	Description
MANY	Aggregators with this cardinality may be collected many times.
NONE	Aggregators with this cardinality won't collect any data at all.
ONE	Aggregators with this cardinality will collect be collected once or zero times.

Method Summary

Modifier and Type	Method	Description
abstract CardinalityUpperBound	multiply(int bucketCount)	Get the rough measure of the number of buckets a fixed-bucket Aggregator will collect.
static CardinalityUpperBound	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static CardinalityUpperBound[]	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, 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

NONE

public static final CardinalityUpperBound NONE

Aggregators with this cardinality won't collect any data at all. For the most part this happens when an aggregation is inside of a BucketsAggregator that is pointing to an unmapped field.

ONE

public static final CardinalityUpperBound ONE

Aggregators with this cardinality will collect be collected once or zero times. This will only be true for top level Aggregators and for sub-aggregator's who's ancestors are all single-bucket aggregations like FilterAggregator or a RangeAggregator configured to collect only a single range.

MANY

public static final CardinalityUpperBound MANY

Aggregators with this cardinality may be collected many times. Most sub-aggregators of BucketsAggregators will have this cardinality.

Method Details

values

public static CardinalityUpperBound[] 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 CardinalityUpperBound 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

multiply

public abstract CardinalityUpperBound multiply(int bucketCount)

Get the rough measure of the number of buckets a fixed-bucket Aggregator will collect.

Parameters:

bucketCount - the number of buckets that this Aggregator will collect per owning ordinal