Enum ScoringFunctionAggregation
- java.lang.Object
-
- java.lang.Enum<ScoringFunctionAggregation>
-
- com.azure.search.documents.indexes.models.ScoringFunctionAggregation
-
- All Implemented Interfaces:
Serializable
,Comparable<ScoringFunctionAggregation>
public enum ScoringFunctionAggregation extends Enum<ScoringFunctionAggregation>
Defines values for ScoringFunctionAggregation.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description AVERAGE
Enum value average.FIRST_MATCHING
Enum value firstMatching.MAXIMUM
Enum value maximum.MINIMUM
Enum value minimum.SUM
Enum value sum.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ScoringFunctionAggregation
fromString(String value)
Parses a serialized value to a ScoringFunctionAggregation instance.String
toString()
static ScoringFunctionAggregation
valueOf(String name)
Returns the enum constant of this type with the specified name.static ScoringFunctionAggregation[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
SUM
public static final ScoringFunctionAggregation SUM
Enum value sum.
-
AVERAGE
public static final ScoringFunctionAggregation AVERAGE
Enum value average.
-
MINIMUM
public static final ScoringFunctionAggregation MINIMUM
Enum value minimum.
-
MAXIMUM
public static final ScoringFunctionAggregation MAXIMUM
Enum value maximum.
-
FIRST_MATCHING
public static final ScoringFunctionAggregation FIRST_MATCHING
Enum value firstMatching.
-
-
Method Detail
-
values
public static ScoringFunctionAggregation[] 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 (ScoringFunctionAggregation c : ScoringFunctionAggregation.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static ScoringFunctionAggregation 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
-
fromString
public static ScoringFunctionAggregation fromString(String value)
Parses a serialized value to a ScoringFunctionAggregation instance.- Parameters:
value
- the serialized value to parse.- Returns:
- the parsed ScoringFunctionAggregation object, or null if unable to parse.
-
toString
public String toString()
- Overrides:
toString
in classEnum<ScoringFunctionAggregation>
-
-