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

Enum FieldValueFactorModifier

java.lang.Object

java.lang.Enum<FieldValueFactorModifier>

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

All Implemented Interfaces:

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

@JsonpDeserializable
public enum FieldValueFactorModifier
extends java.lang.Enum<FieldValueFactorModifier>
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
Ln
Ln1p
Ln2p
Log
Log1p
Log2p
None
Reciprocal
Sqrt
Square

Field Summary

Fields

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

Method Summary

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

None

public static final FieldValueFactorModifier None

Log

public static final FieldValueFactorModifier Log

Log1p

public static final FieldValueFactorModifier Log1p

Log2p

public static final FieldValueFactorModifier Log2p

Ln

public static final FieldValueFactorModifier Ln

Ln1p

public static final FieldValueFactorModifier Ln1p

Ln2p

public static final FieldValueFactorModifier Ln2p

Square

public static final FieldValueFactorModifier Square

Sqrt

public static final FieldValueFactorModifier Sqrt

Reciprocal

public static final FieldValueFactorModifier Reciprocal

Field Detail

_DESERIALIZER

public static final JsonEnum.Deserializer<FieldValueFactorModifier> _DESERIALIZER

Method Detail

values

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

Returns:

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

valueOf

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