Package org.elasticsearch.cluster.routing.allocation.command

Class CancelAllocationCommand

java.lang.Object

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

All Implemented Interfaces:

AllocationCommand, NamedWriteable, Writeable, ToXContent, ToXContentObject

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/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final ParseField	COMMAND_NAME_FIELD
static final String	NAME

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
CancelAllocationCommand(String index, int shardId, String node, boolean allowPrimary)	Creates a new CancelAllocationCommand
CancelAllocationCommand(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
boolean	allowPrimary()
boolean	equals(Object obj)
RerouteExplanation	execute(RoutingAllocation allocation, boolean explain)	Executes the command on a RoutingAllocation setup
static CancelAllocationCommand	fromXContent(XContentParser parser)
int	hashCode()
String	index()	Get the index of the shard which allocation should be canceled
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
int	shardId()	Get the id of the shard which allocation should be canceled
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.cluster.routing.allocation.command.AllocationCommand

getMessage, getWriteableName

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

COMMAND_NAME_FIELD

public static final ParseField COMMAND_NAME_FIELD

Constructor Details

CancelAllocationCommand

public CancelAllocationCommand(String index,
 int shardId,
 String node,
 boolean allowPrimary)

Creates a new CancelAllocationCommand

Parameters:

index - index of the shard which allocation should be canceled

shardId - id of the shard which allocation should be canceled

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

CancelAllocationCommand

public CancelAllocationCommand(StreamInput in)
                        throws IOException

Read from a stream.

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

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

index

public String index()

Get the index of the shard which allocation should be canceled

Returns:

index of the shard which allocation should be canceled

shardId

public int 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

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

fromXContent

public static CancelAllocationCommand fromXContent(XContentParser parser)
                                            throws IOException

Throws:

IOException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object