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
-
Enum Constant Summary
Enum Constants Enum Constant Description MANY
Aggregator
s with this cardinality may be collected many times.NONE
Aggregator
s with this cardinality won't collect any data at all.ONE
Aggregator
s 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-bucketAggregator
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.
-
Enum Constant Details
-
NONE
Aggregator
s with this cardinality won't collect any data at all. For the most part this happens when an aggregation is inside of aBucketsAggregator
that is pointing to an unmapped field. -
ONE
Aggregator
s 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 likeFilterAggregator
or aRangeAggregator
configured to collect only a single range. -
MANY
Aggregator
s with this cardinality may be collected many times. Most sub-aggregators ofBucketsAggregator
s will have this cardinality.
-
-
Method Details
-
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
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 namejava.lang.NullPointerException
- if the argument is null
-
multiply
Get the rough measure of the number of buckets a fixed-bucketAggregator
will collect.- Parameters:
bucketCount
- the number of buckets that thisAggregator
will collect per owning ordinal
-