org.elasticsearch.action.support.tasks

Class BaseTasksRequest<T extends BaseTasksRequest>

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<T>

org.elasticsearch.action.support.tasks.BaseTasksRequest<T>

All Implemented Interfaces:

HasContext, HasContextAndHeaders, HasHeaders, Streamable

Direct Known Subclasses:

CancelTasksRequest, ListTasksRequest

public class BaseTasksRequest<T extends BaseTasksRequest>
extends ActionRequest<T>

A base class for task requests

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

TransportRequest.Empty

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	ALL_ACTIONS
static String[]	ALL_NODES
static long	ALL_TASKS

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Constructor and Description
BaseTasksRequest()

Method Summary

Methods

Modifier and Type	Method and Description
String[]	getActions() Return the list of action masks for the actions that should be returned
String[]	getNodesIds()
TaskId	getParentTaskId() Returns the parent task id that tasks should be filtered by
TaskId	getTaskId() Returns the id of the task that should be processed.
TimeValue	getTimeout()
boolean	match(Task task)
void	readFrom(StreamInput in)
T	setActions(String... actions) Sets the list of action masks for the actions that should be returned
T	setNodesIds(String... nodesIds)
T	setParentTaskId(TaskId parentTaskId)
T	setTaskId(TaskId taskId)
T	setTimeout(String timeout)
T	setTimeout(TimeValue timeout)
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.transport.TransportRequest

createTask, getDescription

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putHeader, putInContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ALL_ACTIONS

public static final String[] ALL_ACTIONS

ALL_NODES

public static final String[] ALL_NODES

ALL_TASKS

public static final long ALL_TASKS

See Also:

Constant Field Values

Constructor Detail

BaseTasksRequest

public BaseTasksRequest()

Method Detail

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest<T extends BaseTasksRequest>

setActions

public final T setActions(String... actions)

Sets the list of action masks for the actions that should be returned

getActions

public String[] getActions()

Return the list of action masks for the actions that should be returned

getNodesIds

public final String[] getNodesIds()

setNodesIds

public final T setNodesIds(String... nodesIds)

getTaskId

public TaskId getTaskId()

Returns the id of the task that should be processed. By default tasks with any ids are returned.

setTaskId

public final T setTaskId(TaskId taskId)

getParentTaskId

public TaskId getParentTaskId()

Returns the parent task id that tasks should be filtered by

setParentTaskId

public T setParentTaskId(TaskId parentTaskId)

getTimeout

public TimeValue getTimeout()

setTimeout

public final T setTimeout(TimeValue timeout)

setTimeout

public final T setTimeout(String timeout)

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionRequest<T extends BaseTasksRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class ActionRequest<T extends BaseTasksRequest>

Throws:

IOException

match

public boolean match(Task task)