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
,org.elasticsearch.common.util.concurrent.RefCounted
,TaskAwareRequest
public class ListTasksRequest extends BaseTasksRequest<ListTasksRequest>
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
Fields Modifier and Type Field Description static java.lang.String[]
ANY_DESCRIPTION
Fields inherited from class org.elasticsearch.action.support.tasks.BaseTasksRequest
ALL_ACTIONS, ALL_NODES
-
Constructor Summary
Constructors Constructor Description ListTasksRequest()
ListTasksRequest(StreamInput in)
-
Method Summary
Modifier and Type Method Description java.lang.String[]
getDescriptions()
Description patters on which to match.boolean
getDetailed()
Should the detailed task information be returned.boolean
getWaitForCompletion()
Should this request wait for all found tasks to complete?boolean
match(Task task)
ListTasksRequest
setDescriptions(java.lang.String... descriptions)
ListTasksRequest
setDetailed(boolean detailed)
Should the detailed task information be returned.ListTasksRequest
setWaitForCompletion(boolean waitForCompletion)
Should this request wait for all found tasks to complete?ActionRequestValidationException
validate()
void
writeTo(StreamOutput out)
Write this into the StreamOutput.Methods inherited from class org.elasticsearch.action.support.tasks.BaseTasksRequest
getActions, getNodes, getParentTaskId, getTaskId, getTimeout, setActions, setNodes, setParentTaskId, setTaskId, setTimeout, setTimeout
Methods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResult
Methods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, setParentTask, toString
Methods inherited from class org.elasticsearch.transport.TransportMessage
decRef, 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.tasks.TaskAwareRequest
createTask, getDescription, setParentTask
-
Field Details
-
ANY_DESCRIPTION
public static final java.lang.String[] ANY_DESCRIPTION
-
-
Constructor Details
-
ListTasksRequest
public ListTasksRequest() -
ListTasksRequest
- Throws:
java.io.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:
java.io.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
public java.lang.String[] 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
-