org.elasticsearch.index.engine

Enum EngineConfig.OpenMode

java.lang.Object

java.lang.Enum<EngineConfig.OpenMode>

org.elasticsearch.index.engine.EngineConfig.OpenMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<EngineConfig.OpenMode>

Enclosing class:

EngineConfig

public static enum EngineConfig.OpenMode
extends java.lang.Enum<EngineConfig.OpenMode>

Engine open mode defines how the engine should be opened or in other words what the engine should expect to recover from. We either create a brand new engine with a new index and translog or we recover from an existing index. If the index exists we also have the ability open only the index and create a new transaction log which happens during remote recovery since we have already transferred the index files but the translog is replayed from remote. The last and safest option opens the lucene index as well as it's referenced transaction log for a translog recovery. See also Engine.recoverFromTranslog()

Enum Constant Summary

Enum Constants

Enum Constant and Description
CREATE_INDEX_AND_TRANSLOG
OPEN_INDEX_AND_TRANSLOG
OPEN_INDEX_CREATE_TRANSLOG

Method Summary

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

CREATE_INDEX_AND_TRANSLOG

public static final EngineConfig.OpenMode CREATE_INDEX_AND_TRANSLOG

OPEN_INDEX_CREATE_TRANSLOG

public static final EngineConfig.OpenMode OPEN_INDEX_CREATE_TRANSLOG

OPEN_INDEX_AND_TRANSLOG

public static final EngineConfig.OpenMode OPEN_INDEX_AND_TRANSLOG

Method Detail

values

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

Returns:

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

valueOf

public static EngineConfig.OpenMode 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 name

java.lang.NullPointerException - if the argument is null