Class CancelTasksRequest
- java.lang.Object
-
- org.elasticsearch.transport.TransportMessage
-
- org.elasticsearch.transport.TransportRequest
-
- org.elasticsearch.action.ActionRequest
-
- org.elasticsearch.action.support.tasks.BaseTasksRequest<CancelTasksRequest>
-
- org.elasticsearch.action.admin.cluster.node.tasks.cancel.CancelTasksRequest
-
- All Implemented Interfaces:
Streamable
,Writeable
,TaskAwareRequest
public class CancelTasksRequest extends BaseTasksRequest<CancelTasksRequest>
A request to cancel tasks
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest
TransportRequest.Empty
-
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 java.lang.String
DEFAULT_REASON
-
Fields inherited from class org.elasticsearch.action.support.tasks.BaseTasksRequest
ALL_ACTIONS, ALL_NODES
-
-
Constructor Summary
Constructors Constructor Description CancelTasksRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getReason()
The reason for canceling the task.boolean
match(Task task)
void
readFrom(StreamInput in)
Set this object's fields from a StreamInput.CancelTasksRequest
setReason(java.lang.String reason)
Set the reason for canceling the task.void
writeTo(StreamOutput out)
Write this object's fields to a StreamOutput.-
Methods inherited from class org.elasticsearch.action.support.tasks.BaseTasksRequest
getActions, getNodes, getParentTaskId, getTaskId, getTimeout, setActions, setNodes, setParentTaskId, setTaskId, setTimeout, setTimeout, validate
-
Methods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResult
-
Methods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, setParentTask
-
Methods inherited from class org.elasticsearch.transport.TransportMessage
remoteAddress, remoteAddress
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
createTask, getDescription, setParentTask
-
-
-
-
Field Detail
-
DEFAULT_REASON
public static final java.lang.String DEFAULT_REASON
- See Also:
- Constant Field Values
-
-
Method Detail
-
readFrom
public void readFrom(StreamInput in) throws java.io.IOException
Description copied from interface:Streamable
Set this object's fields from a StreamInput.- Specified by:
readFrom
in interfaceStreamable
- Overrides:
readFrom
in classBaseTasksRequest<CancelTasksRequest>
- Throws:
java.io.IOException
-
writeTo
public void writeTo(StreamOutput out) throws java.io.IOException
Description copied from interface:Streamable
Write this object's fields to a StreamOutput.- Specified by:
writeTo
in interfaceStreamable
- Specified by:
writeTo
in interfaceWriteable
- Overrides:
writeTo
in classBaseTasksRequest<CancelTasksRequest>
- Throws:
java.io.IOException
-
match
public boolean match(Task task)
- Overrides:
match
in classBaseTasksRequest<CancelTasksRequest>
-
setReason
public CancelTasksRequest setReason(java.lang.String reason)
Set the reason for canceling the task.
-
getReason
public java.lang.String getReason()
The reason for canceling the task.
-
-