Enum FacetSortField
- java.lang.Object
-
- java.lang.Enum<FacetSortField>
-
- co.elasticsearch.enterprisesearch.client.model.request.search.facet.FacetSortField
-
- All Implemented Interfaces:
Serializable,Comparable<FacetSortField>
public enum FacetSortField extends Enum<FacetSortField>
Represents a facet sort type
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static FacetSortFieldfromValue(String value)Get a Facet Sort by valueStringgetName()The name of the facetstatic FacetSortFieldvalueOf(String name)Returns the enum constant of this type with the specified name.static FacetSortField[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
COUNT
public static final FacetSortField COUNT
Sort the facet values by count
-
VALUE
public static final FacetSortField VALUE
Sort the facet value by the values
-
-
Method Detail
-
values
public static FacetSortField[] 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 (FacetSortField c : FacetSortField.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static FacetSortField valueOf(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:
IllegalArgumentException- if this enum type has no constant with the specified nameNullPointerException- if the argument is null
-
fromValue
public static FacetSortField fromValue(String value)
Get a Facet Sort by value- Parameters:
value- The value to lookup- Returns:
- The FacetSortField for the value, otherwise an exception will be thrown
-
getName
public String getName()
The name of the facet- Returns:
- the name of the facet
-
-