Package org.opensearch.persistent.decider

Class EnableAssignmentDecider

java.lang.Object

org.opensearch.persistent.decider.EnableAssignmentDecider

public class EnableAssignmentDecider
extends Object

EnableAssignmentDecider is used to allow/disallow the persistent tasks to be assigned to cluster nodes.

Allocation settings can have the following values (non-casesensitive):

• NONE - no persistent tasks can be assigned
• ALL - all persistent tasks can be assigned to nodes

See Also:

• EnableAssignmentDecider.Allocation

Opensearch.internal:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	EnableAssignmentDecider.Allocation	Allocation values or rather their string representation to be used used with CLUSTER_TASKS_ALLOCATION_ENABLE_SETTING via cluster settings.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALLOCATION_NONE_EXPLANATION
static final Setting<EnableAssignmentDecider.Allocation>	CLUSTER_TASKS_ALLOCATION_ENABLE_SETTING

Constructor Summary

Constructors

Constructor	Description
EnableAssignmentDecider(Settings settings, ClusterSettings clusterSettings)

Method Summary

Modifier and Type	Method	Description
AssignmentDecision	canAssign()	Returns a AssignmentDecision whether the given persistent task can be assigned to a node of the cluster.
void	setEnableAssignment(EnableAssignmentDecider.Allocation enableAssignment)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CLUSTER_TASKS_ALLOCATION_ENABLE_SETTING

public static final Setting<EnableAssignmentDecider.Allocation> CLUSTER_TASKS_ALLOCATION_ENABLE_SETTING

ALLOCATION_NONE_EXPLANATION

public static final String ALLOCATION_NONE_EXPLANATION

See Also:

• Constant Field Values

Constructor Details

EnableAssignmentDecider

public EnableAssignmentDecider(Settings settings,
 ClusterSettings clusterSettings)

Method Details

setEnableAssignment

public void setEnableAssignment(EnableAssignmentDecider.Allocation enableAssignment)

canAssign

public AssignmentDecision canAssign()

Returns a AssignmentDecision whether the given persistent task can be assigned to a node of the cluster. The decision depends on the current value of the setting CLUSTER_TASKS_ALLOCATION_ENABLE_SETTING.

Returns:

the AssignmentDecision