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

Enum Class FieldValueFactorModifier

java.lang.Object

java.lang.Enum<FieldValueFactorModifier>

org.opensearch.client.opensearch._types.query_dsl.FieldValueFactorModifier

All Implemented Interfaces:

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

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public enum FieldValueFactorModifier
extends Enum<FieldValueFactorModifier>
implements JsonEnum

Nested Class Summary

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

Enum.EnumDesc<E extends Enum<E>>

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

JsonEnum.Deserializer<T extends JsonEnum>

Enum Constant Summary

Enum Constants

Enum Constant	Description
Ln
Ln1p
Ln2p
Log
Log1p
Log2p
None
Reciprocal
Sqrt
Square

Field Summary

Fields

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

Method Summary

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

aliases, serialize

Enum Constant Details

Ln

public static final FieldValueFactorModifier Ln

Ln1p

public static final FieldValueFactorModifier Ln1p

Ln2p

public static final FieldValueFactorModifier Ln2p

Log

public static final FieldValueFactorModifier Log

Log1p

public static final FieldValueFactorModifier Log1p

Log2p

public static final FieldValueFactorModifier Log2p

None

public static final FieldValueFactorModifier None

Reciprocal

public static final FieldValueFactorModifier Reciprocal

Sqrt

public static final FieldValueFactorModifier Sqrt

Square

public static final FieldValueFactorModifier Square

Field Details

_DESERIALIZER

public static final JsonEnum.Deserializer<FieldValueFactorModifier> _DESERIALIZER

Method Details

values

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