Package org.opensearch.client.opensearch._types

Enum Class TermFrequencyNormalization

java.lang.Object

java.lang.Enum<TermFrequencyNormalization>

org.opensearch.client.opensearch._types.TermFrequencyNormalization

All Implemented Interfaces:

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

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public enum TermFrequencyNormalization
extends Enum<TermFrequencyNormalization>
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
H1	The first normalization of Hazm.
H2	The second normalization of Hazm.
H3	The third normalization of Hazm.
No	No normalization.
Z	The Zipfian normalization.

Field Summary

Fields

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

Method Summary

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

H1

public static final TermFrequencyNormalization H1

The first normalization of Hazm.

H2

public static final TermFrequencyNormalization H2

The second normalization of Hazm.

H3

public static final TermFrequencyNormalization H3

The third normalization of Hazm.

No

public static final TermFrequencyNormalization No

No normalization.

Z

public static final TermFrequencyNormalization Z

The Zipfian normalization.

Field Details

_DESERIALIZER

public static final JsonEnum.Deserializer<TermFrequencyNormalization> _DESERIALIZER

Method Details

values

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