Module org.elasticsearch.server

Package org.elasticsearch.action

Class ActionRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.AbstractTransportRequest

org.elasticsearch.action.ActionRequest

All Implemented Interfaces:

Writeable, RefCounted, TaskAwareRequest, TransportRequest

Direct Known Subclasses:

UntypedActionRequest

public abstract class ActionRequest
extends AbstractTransportRequest

In due course we intend to make ActionRequest strongly-typed in its ActionResponse type, and then to migrate each UntypedActionRequest instances to the new typed world. Until the strongly-typed ActionRequest is available, please continue to use UntypedActionRequest for all new request types.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Constructor	Description
ActionRequest()
ActionRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	getShouldStoreResult()	Should this task store its result after it has finished?
abstract ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.transport.AbstractTransportRequest

getParentTask, getRequestId, remoteAddress, remoteAddress, setParentTask, setRequestId, toString

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, tryIncRef

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.core.RefCounted

decRef, hasReferences, incRef, mustIncRef, tryIncRef

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, createTask, getDescription, setParentTask

Constructor Details

ActionRequest

public ActionRequest()

ActionRequest

public ActionRequest(StreamInput in)
              throws IOException

Throws:

IOException

Method Details

validate

public abstract ActionRequestValidationException validate()

getShouldStoreResult

public boolean getShouldStoreResult()

Should this task store its result after it has finished?

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 AbstractTransportRequest

Throws:

IOException