Package org.opensearch.client.opensearch._types

Enum Class SortMode

java.lang.Object

java.lang.Enum<SortMode>

org.opensearch.client.opensearch._types.SortMode

All Implemented Interfaces:

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

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public enum SortMode
extends Enum<SortMode>
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
Avg	Use the average of all values.
Max	Use the maximum value.
Median	Use the median value.
Min	Use the minimum value.
Sum	Use the sum of all values.

Field Summary

Fields

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

Method Summary

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

Avg

public static final SortMode Avg

Use the average of all values.

Max

public static final SortMode Max

Use the maximum value.

Median

public static final SortMode Median

Use the median value.

Min

public static final SortMode Min

Use the minimum value.

Sum

public static final SortMode Sum

Use the sum of all values.

Field Details

_DESERIALIZER

public static final JsonEnum.Deserializer<SortMode> _DESERIALIZER

Method Details

values

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