Package org.opensearch.search.pipeline.common

Enum SortResponseProcessor.SortOrder

java.lang.Object

java.lang.Enum<SortResponseProcessor.SortOrder>

org.opensearch.search.pipeline.common.SortResponseProcessor.SortOrder

All Implemented Interfaces:

Serializable, Comparable<SortResponseProcessor.SortOrder>

Enclosing class:

SortResponseProcessor

public static enum SortResponseProcessor.SortOrder
extends Enum<SortResponseProcessor.SortOrder>

Enum defining how elements will be sorted

Enum Constant Summary

Enum Constants

Enum Constant	Description
ASCENDING	Sort in ascending (natural) order
DESCENDING	Sort in descending (reverse) order

Method Summary

Modifier and Type	Method	Description
static SortResponseProcessor.SortOrder	fromString(String value)	Converts the string representation of the enum value to the enum.
String	toString()
static SortResponseProcessor.SortOrder	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SortResponseProcessor.SortOrder[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ASCENDING

public static final SortResponseProcessor.SortOrder ASCENDING

Sort in ascending (natural) order

DESCENDING

public static final SortResponseProcessor.SortOrder DESCENDING

Sort in descending (reverse) order

Method Details

values

public static SortResponseProcessor.SortOrder[] values()

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

Returns:

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

valueOf

public static SortResponseProcessor.SortOrder valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<SortResponseProcessor.SortOrder>

fromString

public static SortResponseProcessor.SortOrder fromString(String value)

Converts the string representation of the enum value to the enum.

Parameters:

value - A string ("asc" or "desc")

Returns:

the corresponding enum value