Package org.elasticsearch.search.aggregations

Enum AggregationBuilder.BucketCardinality

java.lang.Object
java.lang.Enum<AggregationBuilder.BucketCardinality>
org.elasticsearch.search.aggregations.AggregationBuilder.BucketCardinality
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<AggregationBuilder.BucketCardinality>, java.lang.constant.Constable
Enclosing class:
AggregationBuilder
public static enum AggregationBuilder.BucketCardinality
extends java.lang.Enum<AggregationBuilder.BucketCardinality>
Rough measure of how many buckets this aggregation can return. Just "zero", "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  
    NONE  
    ONE  

  • Method Summary

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

  • Method Details

    • values

      public static AggregationBuilder.BucketCardinality[] 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 AggregationBuilder.BucketCardinality 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