com.attivio.sdk.ingest

Enum Optimize.BackgroundMode

java.lang.Object

java.lang.Enum<Optimize.BackgroundMode>

com.attivio.sdk.ingest.Optimize.BackgroundMode

All Implemented Interfaces:

Serializable, Comparable<Optimize.BackgroundMode>

Enclosing class:

Optimize

public static enum Optimize.BackgroundMode
extends Enum<Optimize.BackgroundMode>

BackgroundMode specifies if optimize will block ingestion of documents while running.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BACKGROUND Segment merging will be run in the background.
DEFAULT Segments will be merged according to the system configuration.
FOREGROUND Segment merging will be run in the foreground.

Method Summary

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

DEFAULT

public static final Optimize.BackgroundMode DEFAULT

Segments will be merged according to the system configuration.

FOREGROUND

public static final Optimize.BackgroundMode FOREGROUND

Segment merging will be run in the foreground.

All segments will have been optimized when this message is completed. NOTE: this will block ingestion of documents until the optimize is completed.

BACKGROUND

public static final Optimize.BackgroundMode BACKGROUND

Segment merging will be run in the background.

Supports concurrent ingestion of documents, however the merged index will not be used for search until a subsequent Commit message is issued once all segments have been merged.

Method Detail

values

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

Returns:

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

valueOf

public static Optimize.BackgroundMode 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