Interface AllocationCommand
- All Superinterfaces:
NamedWriteable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentObject
,Writeable
- All Known Implementing Classes:
AbstractAllocateAllocationCommand
,AllocateEmptyPrimaryAllocationCommand
,AllocateReplicaAllocationCommand
,AllocateStalePrimaryAllocationCommand
,BasePrimaryAllocationCommand
,CancelAllocationCommand
,MoveAllocationCommand
public interface AllocationCommand
extends NamedWriteable, org.elasticsearch.common.xcontent.ToXContentObject
A command to move shards in some way.
Commands are registered in
NetworkModule
.-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Field Summary
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
Method Summary
Modifier and TypeMethodDescriptionexecute(RoutingAllocation allocation, boolean explain)
Executes the command on aRoutingAllocation
setupdefault <>
Returns any feedback the command wants to provide for logging.default
Returns the name of the writeable objectname()
Get the name of the commandMethods inherited from interface org.elasticsearch.common.xcontent.ToXContent
toXContent
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject
isFragment
-
Method Details
-
name
name()Get the name of the command- Returns:
- name of the command
-
execute
Executes the command on aRoutingAllocation
setup- Parameters:
allocation
-RoutingAllocation
to modify- Throws:
ElasticsearchException
- if something happens during reconfiguration
-
getWriteableName
default getWriteableName()Description copied from interface:NamedWriteable
Returns the name of the writeable object- Specified by:
getWriteableName
in interfaceNamedWriteable
-
getMessage
default <> getMessage()Returns any feedback the command wants to provide for logging. This message should be appropriate to expose to the user after the command has been applied
-