Package org.opensearch.client.core

Enum IndexerState

java.lang.Object

java.lang.Enum<IndexerState>

org.opensearch.client.core.IndexerState

All Implemented Interfaces:

Serializable, Comparable<IndexerState>

public enum IndexerState
extends Enum<IndexerState>

IndexerState represents the internal state of the indexer. It is also persistent when changing from started/stopped in case the allocated task is restarted elsewhere.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ABORTING	Something (internal or external) has requested the indexer abort and shutdown.
INDEXING	Indexer is actively indexing data.
STARTED	Indexer is running, but not actively indexing data (e.g.
STOPPED	Indexer is "paused" and ignoring scheduled triggers.
STOPPING	Transition state to where an indexer has acknowledged the stop but is still in process of halting.

Method Summary

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

STARTED

public static final IndexerState STARTED

Indexer is running, but not actively indexing data (e.g. it's idle).

INDEXING

public static final IndexerState INDEXING

Indexer is actively indexing data.

STOPPING

public static final IndexerState STOPPING

Transition state to where an indexer has acknowledged the stop but is still in process of halting.

STOPPED

public static final IndexerState STOPPED

Indexer is "paused" and ignoring scheduled triggers.

ABORTING

public static final IndexerState ABORTING

Something (internal or external) has requested the indexer abort and shutdown.

Method Details

values

public static IndexerState[] values()

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

Returns:

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

valueOf

public static IndexerState 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

fromString

public static IndexerState fromString(String name)

value

public String value()