Package org.opensearch.client.opensearch._types

Enum SortOptions.Kind

java.lang.Object

java.lang.Enum<SortOptions.Kind>

org.opensearch.client.opensearch._types.SortOptions.Kind

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SortOptions.Kind>, JsonEnum, JsonpSerializable

Enclosing class:

SortOptions

public static enum SortOptions.Kind
extends java.lang.Enum<SortOptions.Kind>
implements JsonEnum

SortOptions variant kinds.

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
Doc
Field
GeoDistance
Score
Script

Method Summary

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

Score

public static final SortOptions.Kind Score

Doc

public static final SortOptions.Kind Doc

GeoDistance

public static final SortOptions.Kind GeoDistance

Script

public static final SortOptions.Kind Script

Field

public static final SortOptions.Kind Field

Method Detail

values

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

Returns:

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

valueOf

public static SortOptions.Kind 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