Module org.elasticsearch.server

Package org.elasticsearch.action.search

Enum Class SearchResponse.Cluster.Status

java.lang.Object

java.lang.Enum<SearchResponse.Cluster.Status>

org.elasticsearch.action.search.SearchResponse.Cluster.Status

All Implemented Interfaces:

Serializable, Comparable<SearchResponse.Cluster.Status>, Constable

Enclosing class:

SearchResponse.Cluster

public static enum SearchResponse.Cluster.Status
extends Enum<SearchResponse.Cluster.Status>

Marks the status of a Cluster search involved in a Cross-Cluster search.

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
FAILED
PARTIAL
RUNNING
SKIPPED
SUCCESSFUL

Method Summary

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

RUNNING

public static final SearchResponse.Cluster.Status RUNNING

SUCCESSFUL

public static final SearchResponse.Cluster.Status SUCCESSFUL

PARTIAL

public static final SearchResponse.Cluster.Status PARTIAL

SKIPPED

public static final SearchResponse.Cluster.Status SKIPPED

FAILED

public static final SearchResponse.Cluster.Status FAILED

Method Details

values

public static SearchResponse.Cluster.Status[] 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 SearchResponse.Cluster.Status 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

toString

public String toString()

Overrides:

toString in class Enum<SearchResponse.Cluster.Status>