Package com.azure.search.documents.indexes.models

Enum ScoringFunctionAggregation

java.lang.Object

java.lang.Enum<ScoringFunctionAggregation>

com.azure.search.documents.indexes.models.ScoringFunctionAggregation

All Implemented Interfaces:

Serializable, Comparable<ScoringFunctionAggregation>, java.lang.constant.Constable

public enum ScoringFunctionAggregation
extends Enum<ScoringFunctionAggregation>

Defines the aggregation function used to combine the results of all the scoring functions in a scoring profile.

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
AVERAGE	Boost scores by the average of all scoring function results.
FIRST_MATCHING	Boost scores using the first applicable scoring function in the scoring profile.
MAXIMUM	Boost scores by the maximum of all scoring function results.
MINIMUM	Boost scores by the minimum of all scoring function results.
SUM	Boost scores by the sum of all scoring function results.

Method Summary

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.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SUM

public static final ScoringFunctionAggregation SUM

Boost scores by the sum of all scoring function results.

AVERAGE

public static final ScoringFunctionAggregation AVERAGE

Boost scores by the average of all scoring function results.

MINIMUM

public static final ScoringFunctionAggregation MINIMUM

Boost scores by the minimum of all scoring function results.

MAXIMUM

public static final ScoringFunctionAggregation MAXIMUM

Boost scores by the maximum of all scoring function results.

FIRST_MATCHING

public static final ScoringFunctionAggregation FIRST_MATCHING

Boost scores using the first applicable scoring function in the scoring profile.

Method Details

values

public static ScoringFunctionAggregation[] 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 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 name

NullPointerException - 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 class Enum<ScoringFunctionAggregation>