org.springframework.data.elasticsearch.core.query

Enum IndicesOptions.Option

java.lang.Object

java.lang.Enum<IndicesOptions.Option>

org.springframework.data.elasticsearch.core.query.IndicesOptions.Option

All Implemented Interfaces:

Serializable, Comparable<IndicesOptions.Option>

Enclosing class:

IndicesOptions

public static enum IndicesOptions.Option
extends Enum<IndicesOptions.Option>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALLOW_NO_INDICES
FORBID_ALIASES_TO_MULTIPLE_INDICES
FORBID_CLOSED_INDICES
IGNORE_ALIASES
IGNORE_THROTTLED
IGNORE_UNAVAILABLE

Method Summary

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

IGNORE_UNAVAILABLE

public static final IndicesOptions.Option IGNORE_UNAVAILABLE

IGNORE_ALIASES

public static final IndicesOptions.Option IGNORE_ALIASES

ALLOW_NO_INDICES

public static final IndicesOptions.Option ALLOW_NO_INDICES

FORBID_ALIASES_TO_MULTIPLE_INDICES

public static final IndicesOptions.Option FORBID_ALIASES_TO_MULTIPLE_INDICES

FORBID_CLOSED_INDICES

public static final IndicesOptions.Option FORBID_CLOSED_INDICES

IGNORE_THROTTLED

public static final IndicesOptions.Option IGNORE_THROTTLED

Method Detail

values

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

Returns:

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

valueOf

public static IndicesOptions.Option 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