org.elasticsearch.cluster.routing.allocation.command

Class CancelAllocationCommand

java.lang.Object

org.elasticsearch.cluster.routing.allocation.command.CancelAllocationCommand

All Implemented Interfaces:

AllocationCommand

public class CancelAllocationCommand
extends Object
implements AllocationCommand

A command that cancels relocation, or recovery of a given shard on a node.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CancelAllocationCommand.Factory Factory creating CancelAllocationCommands

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Constructor Summary

Constructors

Constructor and Description
CancelAllocationCommand(ShardId shardId, String node, boolean allowPrimary) Creates a new CancelAllocationCommand

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allowPrimary()
RerouteExplanation	execute(RoutingAllocation allocation, boolean explain) Executes the command on a RoutingAllocation setup
String	name() Get the name of the command
String	node() Get the id of the node that manages the shard which allocation should be canceled
ShardId	shardId() Get the id of the shard which allocation should be canceled

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

CancelAllocationCommand

public CancelAllocationCommand(ShardId shardId,
                       String node,
                       boolean allowPrimary)

Creates a new CancelAllocationCommand

Parameters:

shardId - id of the shard which allocation should be canceled

node - id of the node that manages the shard which allocation should be canceled

Method Detail

name

public String name()

Description copied from interface: AllocationCommand

Get the name of the command

Specified by:

name in interface AllocationCommand

Returns:

name of the command

shardId

public ShardId shardId()

Get the id of the shard which allocation should be canceled

Returns:

id of the shard which allocation should be canceled

node

public String node()

Get the id of the node that manages the shard which allocation should be canceled

Returns:

id of the node that manages the shard which allocation should be canceled

allowPrimary

public boolean allowPrimary()

execute

public RerouteExplanation execute(RoutingAllocation allocation,
                         boolean explain)

Description copied from interface: AllocationCommand

Executes the command on a RoutingAllocation setup

Specified by:

execute in interface AllocationCommand

Parameters:

allocation - RoutingAllocation to modify