Enum Preference
- java.lang.Object
-
- java.lang.Enum<Preference>
-
- org.elasticsearch.cluster.routing.Preference
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<Preference>
public enum Preference extends java.lang.Enum<Preference>
Routing Preference Type
-
-
Enum Constant Summary
Enum Constants Enum Constant Description LOCAL
Route to local node, if possibleONLY_LOCAL
Route to the local shard onlyONLY_NODES
Route to only node with attributePREFER_NODES
Route to preferred nodes, if possibleSHARDS
Route to specific shards
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Preference
parse(java.lang.String preference)
Parses the Preference Type given a stringjava.lang.String
type()
static Preference
valueOf(java.lang.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.
-
-
-
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(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 namejava.lang.NullPointerException
- if the argument is null
-
type
public java.lang.String type()
-
parse
public static Preference parse(java.lang.String preference)
Parses the Preference Type given a string
-
-