Package co.elastic.clients.elasticsearch._types.query_dsl

Enum Class FunctionBoostMode

java.lang.Object

java.lang.Enum<FunctionBoostMode>

co.elastic.clients.elasticsearch._types.query_dsl.FunctionBoostMode

All Implemented Interfaces:

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

@JsonpDeserializable
public enum FunctionBoostMode
extends Enum<FunctionBoostMode>
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	Query score and function score are averaged
Max	Max of query score and function score
Min	Min of query score and function score
Multiply	Query score and function score are multiplied
Replace	Only the function score is used.
Sum	Query score and function score are added

Field Summary

Fields

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

Method Summary

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

Multiply

public static final FunctionBoostMode Multiply

Query score and function score are multiplied

Replace

public static final FunctionBoostMode Replace

Only the function score is used. The query score is ignored.

Sum

public static final FunctionBoostMode Sum

Query score and function score are added

Avg

public static final FunctionBoostMode Avg

Query score and function score are averaged

Max

public static final FunctionBoostMode Max

Max of query score and function score

Min

public static final FunctionBoostMode Min

Min of query score and function score

Field Details

_DESERIALIZER

public static final JsonEnum.Deserializer<FunctionBoostMode> _DESERIALIZER

Method Details

values

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