Package org.elasticsearch.action.support.tasks

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:

Streamable, Writeable, TaskAwareRequest

Direct Known Subclasses:

CancelTasksRequest, ListTasksRequest

public class BaseTasksRequest<Request extends BaseTasksRequest<Request>>
extends ActionRequest

A base class for task requests

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[]	ALL_ACTIONS
static java.lang.String[]	ALL_NODES

Constructor Summary

Constructors

Constructor	Description
BaseTasksRequest()

Method Summary

Modifier and Type	Method	Description
java.lang.String[]	getActions()	Return the list of action masks for the actions that should be returned
java.lang.String[]	getNodes()
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)	Set this object's fields from a StreamInput.
Request	setActions(java.lang.String... actions)	Sets the list of action masks for the actions that should be returned
Request	setNodes(java.lang.String... nodes)
Request	setParentTaskId(TaskId parentTaskId)
Request	setTaskId(TaskId taskId)
Request	setTimeout(java.lang.String timeout)
Request	setTimeout(TimeValue timeout)
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)	Write this object's fields to a StreamOutput.

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.io.stream.Streamable

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, setParentTask

Field Detail

ALL_ACTIONS

public static final java.lang.String[] ALL_ACTIONS

ALL_NODES

public static final java.lang.String[] ALL_NODES

Constructor Detail

BaseTasksRequest

public BaseTasksRequest()

Method Detail

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

setActions

public final Request setActions(java.lang.String... actions)

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

getActions

public java.lang.String[] getActions()

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

getNodes

public final java.lang.String[] getNodes()

setNodes

public final Request setNodes(java.lang.String... nodes)

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 Request setTaskId(TaskId taskId)

getParentTaskId

public TaskId getParentTaskId()

Returns the parent task id that tasks should be filtered by

setParentTaskId

public Request setParentTaskId(TaskId parentTaskId)

getTimeout

public TimeValue getTimeout()

setTimeout

public final Request setTimeout(TimeValue timeout)

setTimeout

public final Request setTimeout(java.lang.String timeout)

readFrom

public void readFrom(StreamInput in)
              throws java.io.IOException

Description copied from interface: Streamable

Set this object's fields from a StreamInput.

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionRequest

Throws:

java.io.IOException

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Streamable

Write this object's fields to a StreamOutput.

Specified by:

writeTo in interface Streamable

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ActionRequest

Throws:

java.io.IOException

match

public boolean match(Task task)