org.elasticsearch.action.admin.cluster.node.tasks.cancel

Class CancelTasksRequest

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<CancelTasksRequest>

org.elasticsearch.action.admin.cluster.node.tasks.cancel.CancelTasksRequest

All Implemented Interfaces:

HasContext, HasContextAndHeaders, HasHeaders, Streamable

public class CancelTasksRequest
extends BaseTasksRequest<CancelTasksRequest>

A request to cancel tasks

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	DEFAULT_REASON

Fields inherited from class org.elasticsearch.action.support.tasks.BaseTasksRequest

ALL_ACTIONS, ALL_NODES, ALL_TASKS

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Constructor and Description
CancelTasksRequest()

Method Summary

Methods

Modifier and Type	Method and Description
String	getReason() The reason for canceling the task.
boolean	match(Task task)
void	readFrom(StreamInput in)
CancelTasksRequest	setReason(String reason) Set the reason for canceling the task.
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.action.support.tasks.BaseTasksRequest

getActions, getNodesIds, getParentTaskId, getTaskId, getTimeout, setActions, setNodesIds, setParentTaskId, setTaskId, setTimeout, setTimeout, validate

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

DEFAULT_REASON

public static final String DEFAULT_REASON

See Also:

Constant Field Values

Constructor Detail

CancelTasksRequest

public CancelTasksRequest()

Method Detail

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class BaseTasksRequest<CancelTasksRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class BaseTasksRequest<CancelTasksRequest>

Throws:

IOException

match

public boolean match(Task task)

Overrides:

match in class BaseTasksRequest<CancelTasksRequest>

setReason

public CancelTasksRequest setReason(String reason)

Set the reason for canceling the task.

getReason

public String getReason()

The reason for canceling the task.