org.elasticsearch.action.support

Class ChildTaskActionRequest<Request extends ActionRequest<Request>>

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<Request>

org.elasticsearch.action.support.ChildTaskActionRequest<Request>

All Implemented Interfaces:

HasContext, HasContextAndHeaders, HasHeaders, Streamable

Direct Known Subclasses:

MasterNodeRequest, ReplicationRequest

public abstract class ChildTaskActionRequest<Request extends ActionRequest<Request>>
extends ActionRequest<Request>

Base class for action requests that can have associated child tasks

Nested Class Summary

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

TransportRequest.Empty

Field Summary

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ChildTaskActionRequest()
protected	ChildTaskActionRequest(ActionRequest request)

Method Summary

Modifier and Type	Method and Description
Task	createTask(long id, String type, String action) Returns the task object that should be used to keep track of the processing of the request.
Task	createTask(long id, String type, String action, TaskId parentTaskId)
void	readFrom(StreamInput in)
void	setParentTask(String parentTaskNode, long parentTaskId)
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.action.ActionRequest

validate

Methods inherited from class org.elasticsearch.transport.TransportRequest

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

Constructor Detail

ChildTaskActionRequest

protected ChildTaskActionRequest()

ChildTaskActionRequest

protected ChildTaskActionRequest(ActionRequest request)

Method Detail

setParentTask

public void setParentTask(String parentTaskNode,
                          long parentTaskId)

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionRequest<Request extends ActionRequest<Request>>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class ActionRequest<Request extends ActionRequest<Request>>

Throws:

IOException

createTask

public final Task createTask(long id,
                             String type,
                             String action)

Description copied from class: TransportRequest

Returns the task object that should be used to keep track of the processing of the request. A request can override this method and return null to avoid being tracked by the task manager.

Overrides:

createTask in class TransportRequest

createTask

public Task createTask(long id,
                       String type,
                       String action,
                       TaskId parentTaskId)