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

Enum Class FieldValueFactorModifier

java.lang.Object

java.lang.Enum<FieldValueFactorModifier>

co.elastic.clients.elasticsearch._types.query_dsl.FieldValueFactorModifier

All Implemented Interfaces:

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

@JsonpDeserializable
public enum FieldValueFactorModifier
extends Enum<FieldValueFactorModifier>
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
Ln	Take the natural logarithm of the field value.
Ln1p	Add 1 to the field value and take the natural logarithm.
Ln2p	Add 2 to the field value and take the natural logarithm.
Log	Take the common logarithm of the field value.
Log1p	Add 1 to the field value and take the common logarithm.
Log2p	Add 2 to the field value and take the common logarithm.
None	Do not apply any multiplier to the field value.
Reciprocal	Reciprocate the field value, same as 1/x where x is the field’s value.
Sqrt	Take the square root of the field value.
Square	Square the field value (multiply it by itself).

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 co.elastic.clients.json.JsonEnum

aliases, serialize

Enum Constant Details

None

public static final FieldValueFactorModifier None

Do not apply any multiplier to the field value.

Log

public static final FieldValueFactorModifier Log

Take the common logarithm of the field value. Because this function will return a negative value and cause an error if used on values between 0 and 1, it is recommended to use log1p instead.

Log1p

public static final FieldValueFactorModifier Log1p

Add 1 to the field value and take the common logarithm.

Log2p

public static final FieldValueFactorModifier Log2p

Add 2 to the field value and take the common logarithm.

Ln

public static final FieldValueFactorModifier Ln

Take the natural logarithm of the field value. Because this function will return a negative value and cause an error if used on values between 0 and 1, it is recommended to use ln1p instead.

Ln1p

public static final FieldValueFactorModifier Ln1p

Add 1 to the field value and take the natural logarithm.

Ln2p

public static final FieldValueFactorModifier Ln2p

Add 2 to the field value and take the natural logarithm.

Square

public static final FieldValueFactorModifier Square

Square the field value (multiply it by itself).

Sqrt

public static final FieldValueFactorModifier Sqrt

Take the square root of the field value.

Reciprocal

public static final FieldValueFactorModifier Reciprocal

Reciprocate the field value, same as 1/x where x is the field’s value.

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