Module org.elasticsearch.server
Class ListTasksRequest
java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.action.support.tasks.BaseTasksRequest<ListTasksRequest>
org.elasticsearch.action.admin.cluster.node.tasks.list.ListTasksRequest
- All Implemented Interfaces:
Writeable
,RefCounted
,TaskAwareRequest
A request to get node 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
FieldsFields inherited from class org.elasticsearch.action.support.tasks.BaseTasksRequest
ALL_ACTIONS, ALL_NODES
Fields inherited from interface org.elasticsearch.core.RefCounted
ALWAYS_REFERENCED
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns the task object that should be used to keep track of the processing of the request.String[]
Description patters on which to match.boolean
Should the detailed task information be returned.boolean
Should this request wait for all found tasks to complete?boolean
setDescriptions
(String... descriptions) setDetailed
(boolean detailed) Should the detailed task information be returned.setWaitForCompletion
(boolean waitForCompletion) Should this request wait for all found tasks to complete?validate()
void
writeTo
(StreamOutput out) Write this into the StreamOutput.Methods inherited from class org.elasticsearch.action.support.tasks.BaseTasksRequest
getActions, getNodes, getParentTaskId, getTargetParentTaskId, getTargetTaskId, getTaskId, getTimeout, setActions, setNodes, setParentTaskId, setTargetParentTaskId, setTargetTaskId, setTaskId, setTimeout, setTimeout
Methods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResult
Methods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, getRequestId, setParentTask, setRequestId, toString
Methods inherited from class org.elasticsearch.transport.TransportMessage
decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.elasticsearch.core.RefCounted
mustIncRef
Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
getDescription, setParentTask
-
Field Details
-
ANY_DESCRIPTION
-
-
Constructor Details
-
ListTasksRequest
public ListTasksRequest() -
ListTasksRequest
- Throws:
IOException
-
-
Method Details
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Overrides:
writeTo
in classBaseTasksRequest<ListTasksRequest>
- Throws:
IOException
-
validate
- Overrides:
validate
in classBaseTasksRequest<ListTasksRequest>
-
match
- Overrides:
match
in classBaseTasksRequest<ListTasksRequest>
-
getDetailed
public boolean getDetailed()Should the detailed task information be returned. -
setDetailed
Should the detailed task information be returned. -
getWaitForCompletion
public boolean getWaitForCompletion()Should this request wait for all found tasks to complete? -
setWaitForCompletion
Should this request wait for all found tasks to complete? -
getDescriptions
Description patters on which to match. If other matching criteria are set, descriptions are matched last once other criteria are satisfied Matching on descriptions is only available if `detailed` is `true`.- Returns:
- array of absolute or simple wildcard matching strings
-
setDescriptions
-
createTask
public Task createTask(long id, String type, String action, TaskId parentTaskId, Map<String, String> headers) Description copied from interface:TaskAwareRequest
Returns the task object that should be used to keep track of the processing of the request.
-