Package com.google.appengine.api.datastore

Enum Class Index.IndexState

java.lang.Object

java.lang.Enum<Index.IndexState>

com.google.appengine.api.datastore.Index.IndexState

All Implemented Interfaces:

Serializable, Comparable<Index.IndexState>, Constable

Enclosing class:

Index

public static enum Index.IndexState
extends Enum<Index.IndexState>

Indicates the state of the Index.

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
BUILDING	Indicates the given Index is being built and therefore can not be used to service queries.
DELETING	Indicates the given Index is being deleted.
ERROR	Indicates the given Index encountered an error in the BUILDING state.
SERVING	Indicates the given Index is ready to service queries.

Method Summary

Modifier and Type	Method	Description
static Index.IndexState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Index.IndexState[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BUILDING

public static final Index.IndexState BUILDING

Indicates the given Index is being built and therefore can not be used to service queries.

SERVING

public static final Index.IndexState SERVING

Indicates the given Index is ready to service queries.

DELETING

public static final Index.IndexState DELETING

Indicates the given Index is being deleted.

ERROR

public static final Index.IndexState ERROR

Indicates the given Index encountered an error in the BUILDING state.

Method Details

values

public static Index.IndexState[] 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 Index.IndexState 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