Package org.elasticsearch.cluster.routing

Enum Preference

java.lang.Object

java.lang.Enum<Preference>

org.elasticsearch.cluster.routing.Preference

All Implemented Interfaces:

Serializable, Comparable<Preference>

public enum Preference
extends Enum<Preference>

Routing Preference Type

Enum Constant Summary

Enum Constants

Enum Constant	Description
LOCAL	Route to local node, if possible
ONLY_LOCAL	Route to the local shard only
ONLY_NODES	Route to only node with attribute
PREFER_NODES	Route to preferred nodes, if possible
SHARDS	Route to specific shards

Method Summary

Modifier and Type	Method	Description
static Preference	parse(String preference)	Parses the Preference Type given a string
String	type()
static Preference	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Preference[]	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

Enum Constant Detail

SHARDS

public static final Preference SHARDS

Route to specific shards

PREFER_NODES

public static final Preference PREFER_NODES

Route to preferred nodes, if possible

LOCAL

public static final Preference LOCAL

Route to local node, if possible

ONLY_LOCAL

public static final Preference ONLY_LOCAL

Route to the local shard only

ONLY_NODES

public static final Preference ONLY_NODES

Route to only node with attribute

Method Detail

values

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

Returns:

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

valueOf

public static Preference 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

type

public String type()

parse

public static Preference parse(String preference)

Parses the Preference Type given a string