Package org.elasticsearch.action

Class ActionRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

All Implemented Interfaces:

Streamable, Writeable, TaskAwareRequest

Direct Known Subclasses:

AbstractBulkByScrollRequest, BaseNodesRequest, BaseTasksRequest, BroadcastRequest, BulkRequest, ClearScrollRequest, FieldCapabilitiesRequest, GetFieldMappingsRequest, GetTaskRequest, InstanceShardOperationRequest, LivenessRequest, MainRequest, MasterNodeRequest, MultiGetRequest, MultiSearchRequest, MultiTermVectorsRequest, PrimaryReplicaSyncer.ResyncRequest, RemoteInfoRequest, ReplicationRequest, SearchRequest, SearchScrollRequest, SimulatePipelineRequest, SingleShardRequest

public abstract class ActionRequest
extends TransportRequest

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>

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?
void	readFrom(StreamInput in)	Set this object's fields from a StreamInput.
abstract ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)	Write this object's fields to a StreamOutput.

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

newWriteableReader

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

Constructor Detail

ActionRequest

public ActionRequest()

ActionRequest

public ActionRequest(StreamInput in)
              throws java.io.IOException

Throws:

java.io.IOException

Method Detail

validate

public abstract ActionRequestValidationException validate()

getShouldStoreResult

public boolean getShouldStoreResult()

Should this task store its result after it has finished?

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 TransportRequest

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 TransportRequest

Throws:

java.io.IOException