Package com.algolia.model.analytics

Enum Class OrderBy

java.lang.Object

java.lang.Enum<OrderBy>

com.algolia.model.analytics.OrderBy

All Implemented Interfaces:

Serializable, Comparable<OrderBy>, Constable

public enum OrderBy
extends Enum<OrderBy>

Method for ordering results. `clickThroughRate`, `conversionRate` and `averageClickPosition` are only available if the `clickAnalytics` parameter is `true`.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AVERAGE_CLICK_POSITION
CLICK_THROUGH_RATE
CONVERSION_RATE
SEARCH_COUNT

Method Summary

Modifier and Type	Method	Description
static OrderBy	fromValue(String value)
String	getValue()
String	toString()
static OrderBy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OrderBy[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SEARCH_COUNT

public static final OrderBy SEARCH_COUNT

CLICK_THROUGH_RATE

public static final OrderBy CLICK_THROUGH_RATE

CONVERSION_RATE

public static final OrderBy CONVERSION_RATE

AVERAGE_CLICK_POSITION

public static final OrderBy AVERAGE_CLICK_POSITION

Method Details

values

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

getValue

public String getValue()

toString

public String toString()

Overrides:

toString in class Enum<OrderBy>

fromValue

public static OrderBy fromValue(String value)