org.elasticsearch.cluster.routing.allocation.decider

Class EnableAllocationDecider

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.cluster.routing.allocation.decider.AllocationDecider

org.elasticsearch.cluster.routing.allocation.decider.EnableAllocationDecider

public class EnableAllocationDecider
extends AllocationDecider

This allocation decider allows shard allocations / rebalancing via the cluster wide settings CLUSTER_ROUTING_ALLOCATION_ENABLE_SETTING / CLUSTER_ROUTING_REBALANCE_ENABLE_SETTING and the per index setting INDEX_ROUTING_ALLOCATION_ENABLE_SETTING / INDEX_ROUTING_REBALANCE_ENABLE_SETTING. The per index settings overrides the cluster wide setting.

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

• NONE - no shard allocation is allowed.
• NEW_PRIMARIES - only primary shards of new indices are allowed to be allocated
• PRIMARIES - only primary shards are allowed to be allocated
• ALL - all shards are allowed to be allocated

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

• NONE - no shard rebalancing is allowed.
• REPLICAS - only replica shards are allowed to be balanced
• PRIMARIES - only primary shards are allowed to be balanced
• ALL - all shards are allowed to be balanced

See Also:

EnableAllocationDecider.Rebalance, EnableAllocationDecider.Allocation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EnableAllocationDecider.Allocation Allocation values or rather their string representation to be used used with CLUSTER_ROUTING_ALLOCATION_ENABLE_SETTING / INDEX_ROUTING_ALLOCATION_ENABLE_SETTING via cluster / index settings.
static class	EnableAllocationDecider.Rebalance Rebalance values or rather their string representation to be used used with CLUSTER_ROUTING_REBALANCE_ENABLE_SETTING / INDEX_ROUTING_REBALANCE_ENABLE_SETTING via cluster / index settings.

Field Summary

Fields

Modifier and Type	Field and Description
static Setting<EnableAllocationDecider.Allocation>	CLUSTER_ROUTING_ALLOCATION_ENABLE_SETTING
static Setting<EnableAllocationDecider.Rebalance>	CLUSTER_ROUTING_REBALANCE_ENABLE_SETTING
static Setting<EnableAllocationDecider.Allocation>	INDEX_ROUTING_ALLOCATION_ENABLE_SETTING
static Setting<EnableAllocationDecider.Rebalance>	INDEX_ROUTING_REBALANCE_ENABLE_SETTING
static java.lang.String	NAME

Fields inherited from class org.elasticsearch.common.component.AbstractComponent

deprecationLogger, logger, settings

Constructor Summary

Constructors

Constructor and Description
EnableAllocationDecider(Settings settings, ClusterSettings clusterSettings)

Method Summary

Modifier and Type	Method and Description
Decision	canAllocate(ShardRouting shardRouting, RoutingNode node, RoutingAllocation allocation) Returns a Decision whether the given shard routing can be allocated on the given node.
Decision	canRebalance(ShardRouting shardRouting, RoutingAllocation allocation) Returns a Decision whether the given shard routing can be re-balanced to the given allocation.
void	setEnableAllocation(EnableAllocationDecider.Allocation enableAllocation)
void	setEnableRebalance(EnableAllocationDecider.Rebalance enableRebalance)

Methods inherited from class org.elasticsearch.cluster.routing.allocation.decider.AllocationDecider

canAllocate, canAllocate, canAllocate, canForceAllocatePrimary, canRebalance, canRemain

Methods inherited from class org.elasticsearch.common.component.AbstractComponent

logDeprecatedSetting, logRemovedSetting, nodeName

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

CLUSTER_ROUTING_ALLOCATION_ENABLE_SETTING

public static final Setting<EnableAllocationDecider.Allocation> CLUSTER_ROUTING_ALLOCATION_ENABLE_SETTING

INDEX_ROUTING_ALLOCATION_ENABLE_SETTING

public static final Setting<EnableAllocationDecider.Allocation> INDEX_ROUTING_ALLOCATION_ENABLE_SETTING

CLUSTER_ROUTING_REBALANCE_ENABLE_SETTING

public static final Setting<EnableAllocationDecider.Rebalance> CLUSTER_ROUTING_REBALANCE_ENABLE_SETTING

INDEX_ROUTING_REBALANCE_ENABLE_SETTING

public static final Setting<EnableAllocationDecider.Rebalance> INDEX_ROUTING_REBALANCE_ENABLE_SETTING

Constructor Detail

EnableAllocationDecider

public EnableAllocationDecider(Settings settings,
                               ClusterSettings clusterSettings)

Method Detail

setEnableRebalance

public void setEnableRebalance(EnableAllocationDecider.Rebalance enableRebalance)

setEnableAllocation

public void setEnableAllocation(EnableAllocationDecider.Allocation enableAllocation)

canAllocate

public Decision canAllocate(ShardRouting shardRouting,
                            RoutingNode node,
                            RoutingAllocation allocation)

Description copied from class: AllocationDecider

Returns a Decision whether the given shard routing can be allocated on the given node. The default is Decision.ALWAYS.

Overrides:

canAllocate in class AllocationDecider

canRebalance

public Decision canRebalance(ShardRouting shardRouting,
                             RoutingAllocation allocation)

Description copied from class: AllocationDecider

Returns a Decision whether the given shard routing can be re-balanced to the given allocation. The default is Decision.ALWAYS.

Overrides:

canRebalance in class AllocationDecider