Package org.opensearch.client.opensearch._types.query_dsl

Enum FunctionBoostMode

java.lang.Object

java.lang.Enum<FunctionBoostMode>

org.opensearch.client.opensearch._types.query_dsl.FunctionBoostMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FunctionBoostMode>, JsonEnum, JsonpSerializable

@JsonpDeserializable
public enum FunctionBoostMode
extends java.lang.Enum<FunctionBoostMode>
implements JsonEnum

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.json.JsonEnum

JsonEnum.Deserializer<T extends JsonEnum>

Enum Constant Summary

Enum Constants

Enum Constant	Description
Avg
Max
Min
Multiply
Replace
Sum

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
java.lang.String	jsonValue()
static FunctionBoostMode	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static FunctionBoostMode[]	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, 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 org.opensearch.client.json.JsonEnum

aliases, serialize

Enum Constant Detail

Multiply

public static final FunctionBoostMode Multiply

Replace

public static final FunctionBoostMode Replace

Sum

public static final FunctionBoostMode Sum

Avg

public static final FunctionBoostMode Avg

Max

public static final FunctionBoostMode Max

Min

public static final FunctionBoostMode Min

Field Detail

_DESERIALIZER

public static final JsonEnum.Deserializer<FunctionBoostMode> _DESERIALIZER

Method Detail

values

public static FunctionBoostMode[] 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 (FunctionBoostMode c : FunctionBoostMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static FunctionBoostMode valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

jsonValue

public java.lang.String jsonValue()

Specified by:

jsonValue in interface JsonEnum