Module org.elasticsearch.server
Class BaseTasksRequest<Request extends BaseTasksRequest<Request>>
java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.action.support.tasks.BaseTasksRequest<Request>
- All Implemented Interfaces:
Writeable,RefCounted,TaskAwareRequest
- Direct Known Subclasses:
CancelTasksRequest,ListTasksRequest
A base class for task requests
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsFields inherited from interface org.elasticsearch.core.RefCounted
ALWAYS_REFERENCED -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionString[]Return the list of action masks for the actions that should be returnedfinal String[]getNodes()Deprecated.Returns the parent task id that tasks should be filtered byReturns the id of the task that should be processed.Deprecated.booleanfinal RequestsetActions(String... actions) Sets the list of action masks for the actions that should be returnedfinal RequestsetParentTaskId(TaskId parentTaskId) Deprecated.setTargetParentTaskId(TaskId targetParentTaskId) final RequestsetTargetTaskId(TaskId targetTaskId) final RequestDeprecated.final RequestsetTimeout(TimeValue timeout) validate()voidwriteTo(StreamOutput out) Write this into the StreamOutput.Methods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResultMethods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, getRequestId, setParentTask, setRequestId, toStringMethods inherited from class org.elasticsearch.transport.TransportMessage
decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRefMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.core.RefCounted
mustIncRefMethods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
createTask, getDescription, setParentTask
-
Field Details
-
ALL_ACTIONS
-
ALL_NODES
-
-
Constructor Details
-
BaseTasksRequest
public BaseTasksRequest() -
BaseTasksRequest
- Throws:
IOException
-
-
Method Details
-
writeTo
Description copied from interface:WriteableWrite this into the StreamOutput.- Specified by:
writeToin interfaceWriteable- Overrides:
writeToin classActionRequest- Throws:
IOException
-
validate
- Specified by:
validatein classActionRequest
-
setActions
Sets the list of action masks for the actions that should be returned -
getActions
Return the list of action masks for the actions that should be returned -
getNodes
-
setNodes
-
getTargetTaskId
Returns the id of the task that should be processed. By default tasks with any ids are returned. -
setTargetTaskId
-
getTaskId
Deprecated. -
setTaskId
Deprecated. -
getTargetParentTaskId
Returns the parent task id that tasks should be filtered by -
setTargetParentTaskId
-
getParentTaskId
Deprecated. -
setParentTaskId
Deprecated. -
getTimeout
-
setTimeout
-
match
-
getTargetParentTaskId()