Package org.opensearch.indices.cluster

Enum IndicesClusterStateService.AllocatedIndices.IndexRemovalReason

java.lang.Object

java.lang.Enum<IndicesClusterStateService.AllocatedIndices.IndexRemovalReason>

org.opensearch.indices.cluster.IndicesClusterStateService.AllocatedIndices.IndexRemovalReason

All Implemented Interfaces:

Serializable, Comparable<IndicesClusterStateService.AllocatedIndices.IndexRemovalReason>

Enclosing interface:

IndicesClusterStateService.AllocatedIndices<T extends IndicesClusterStateService.Shard,U extends IndicesClusterStateService.AllocatedIndex<T>>

@PublicApi(since="1.0.0")
public static enum IndicesClusterStateService.AllocatedIndices.IndexRemovalReason
extends Enum<IndicesClusterStateService.AllocatedIndices.IndexRemovalReason>

Why the index was removed

Opensearch.api:

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLOSED	The index has been closed.
DELETED	The index is deleted.
FAILURE	Something around index management has failed and the index should be removed.
NO_LONGER_ASSIGNED	Shard of this index were previously assigned to this node but all shards have been relocated.
REOPENED	The index has been reopened.

Method Summary

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

NO_LONGER_ASSIGNED

public static final IndicesClusterStateService.AllocatedIndices.IndexRemovalReason NO_LONGER_ASSIGNED

Shard of this index were previously assigned to this node but all shards have been relocated. The index should be removed and all associated resources released. Persistent parts of the index like the shards files, state and transaction logs are kept around in the case of a disaster recovery.

DELETED

public static final IndicesClusterStateService.AllocatedIndices.IndexRemovalReason DELETED

The index is deleted. Persistent parts of the index like the shards files, state and transaction logs are removed once all resources are released.

CLOSED

public static final IndicesClusterStateService.AllocatedIndices.IndexRemovalReason CLOSED

The index has been closed. The index should be removed and all associated resources released. Persistent parts of the index like the shards files, state and transaction logs are kept around in the case of a disaster recovery.

FAILURE

public static final IndicesClusterStateService.AllocatedIndices.IndexRemovalReason FAILURE

Something around index management has failed and the index should be removed. Persistent parts of the index like the shards files, state and transaction logs are kept around in the case of a disaster recovery.

REOPENED

public static final IndicesClusterStateService.AllocatedIndices.IndexRemovalReason REOPENED

The index has been reopened. The index should be removed and all associated resources released. Persistent parts of the index like the shards files, state and transaction logs are kept around in the case of a disaster recovery.

Method Details

values

public static IndicesClusterStateService.AllocatedIndices.IndexRemovalReason[] 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 IndicesClusterStateService.AllocatedIndices.IndexRemovalReason 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