Package org.elasticsearch.search.aggregations

Enum Class AggregationBuilder.BucketCardinality

java.lang.Object

java.lang.Enum<AggregationBuilder.BucketCardinality>

org.elasticsearch.search.aggregations.AggregationBuilder.BucketCardinality

All Implemented Interfaces:

Serializable, Comparable<AggregationBuilder.BucketCardinality>, Constable

Enclosing class:

AggregationBuilder

public static enum AggregationBuilder.BucketCardinality
extends Enum<AggregationBuilder.BucketCardinality>

A rough count of the number of buckets that Aggregators built by this builder will contain per parent bucket used to validate sorts and pipeline aggregations. Just "zero", "one", and "many".

Unlike CardinalityUpperBound which is total instead of per parent bucket.

Nested Class Summary

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
MANY
NONE
ONE

Method Summary

Modifier and Type	Method	Description
static AggregationBuilder.BucketCardinality	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AggregationBuilder.BucketCardinality[]	values()	Returns an array containing the constants of this enum class, 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 AggregationBuilder.BucketCardinality NONE

ONE

public static final AggregationBuilder.BucketCardinality ONE

MANY

public static final AggregationBuilder.BucketCardinality MANY

Method Details

values

public static AggregationBuilder.BucketCardinality[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static AggregationBuilder.BucketCardinality valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null