Package org.elasticsearch.action.admin.cluster.node.tasks.list

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

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 final 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
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(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, 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.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Field Details

ANY_DESCRIPTION

public static final String[] ANY_DESCRIPTION

Constructor Details

ListTasksRequest

public ListTasksRequest()

ListTasksRequest

public ListTasksRequest(StreamInput in)
                 throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class BaseTasksRequest<ListTasksRequest>

Throws:

IOException

validate

public ActionRequestValidationException validate()

Overrides:

validate in class BaseTasksRequest<ListTasksRequest>

match

public boolean match(Task task)

Overrides:

match in class BaseTasksRequest<ListTasksRequest>

getDetailed

public boolean getDetailed()

Should the detailed task information be returned.

setDetailed

public ListTasksRequest setDetailed(boolean detailed)

Should the detailed task information be returned.

getWaitForCompletion

public boolean getWaitForCompletion()

Should this request wait for all found tasks to complete?

setWaitForCompletion

public ListTasksRequest setWaitForCompletion(boolean waitForCompletion)

Should this request wait for all found tasks to complete?

getDescriptions

public 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

public ListTasksRequest setDescriptions(String... descriptions)