Package co.elastic.clients.elasticsearch.core.search

Enum Class ScoreMode

java.lang.Object

java.lang.Enum<ScoreMode>

co.elastic.clients.elasticsearch.core.search.ScoreMode

All Implemented Interfaces:

JsonEnum, JsonpSerializable, Serializable, Comparable<ScoreMode>, Constable

@JsonpDeserializable
public enum ScoreMode
extends Enum<ScoreMode>
implements JsonEnum

See Also:

• API specification

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Nested classes/interfaces inherited from interface co.elastic.clients.json.JsonEnum

JsonEnum.Deserializer<T extends JsonEnum>

Enum Constant Summary

Enum Constants

Enum Constant	Description
Avg	Average the original score and the rescore query score.
Max	Take the max of original score and the rescore query score.
Min	Take the min of the original score and the rescore query score.
Multiply	Multiply the original score by the rescore query score.
Total	Add the original score and the rescore query score.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonEnum.Deserializer<ScoreMode>	_DESERIALIZER

Method Summary

Modifier and Type	Method	Description
String	jsonValue()
static ScoreMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ScoreMode[]	values()	Returns an array containing the constants of this enum class, 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

Methods inherited from interface co.elastic.clients.json.JsonEnum

aliases, serialize

Enum Constant Details

Avg

public static final ScoreMode Avg

Average the original score and the rescore query score.

Max

public static final ScoreMode Max

Take the max of original score and the rescore query score.

Min

public static final ScoreMode Min

Take the min of the original score and the rescore query score.

Multiply

public static final ScoreMode Multiply

Multiply the original score by the rescore query score. Useful for function query rescores.

Total

public static final ScoreMode Total

Add the original score and the rescore query score.

Field Details

_DESERIALIZER

public static final JsonEnum.Deserializer<ScoreMode> _DESERIALIZER

Method Details

values

public static ScoreMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ScoreMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

jsonValue

public String jsonValue()

Specified by:

jsonValue in interface JsonEnum