org.elasticsearch.transport

Class TransportRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

All Implemented Interfaces:

Streamable

Direct Known Subclasses:

ActionRequest, BaseNodeRequest, BroadcastShardRequest, BytesTransportRequest, InternalScrollSearchRequest, LocalAllocateDangledIndices.AllocateDangledRequest, MasterFaultDetection.MasterPingRequest, MembershipAction.JoinRequest, MembershipAction.LeaveRequest, NodeMappingRefreshAction.NodeMappingRefreshRequest, NodesFaultDetection.PingRequest, PublishClusterStateAction.CommitClusterStateRequest, QuerySearchRequest, RecoveryCleanFilesRequest, RecoveryFileChunkRequest, RecoveryFilesInfoRequest, RecoveryFinalizeRecoveryRequest, RecoveryPrepareForTranslogOperationsRequest, RecoveryTranslogOperationsRequest, RecoveryWaitForClusterStateRequest, RestoreService.UpdateIndexShardRestoreStatusRequest, ShardFetchRequest, ShardSearchTransportRequest, ShardStateAction.ShardEntry, SnapshotShardsService.UpdateIndexShardSnapshotStatusRequest, StartRecoveryRequest, SyncedFlushService.InFlightOpsRequest, SyncedFlushService.PreShardSyncedFlushRequest, SyncedFlushService.ShardSyncedFlushRequest, TransportBroadcastByNodeAction.NodeRequest, TransportReplicationAction.ConcreteShardRequest, TransportRequest.Empty, UnicastZenPing.UnicastPingRequest, VerifyNodeRepositoryAction.VerifyNodeRepositoryRequest, ZenDiscovery.RejoinClusterRequest

public abstract class TransportRequest
extends TransportMessage

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TransportRequest.Empty

Constructor Summary

Constructors

Constructor and Description
TransportRequest()

Method Summary

Modifier and Type	Method and Description
Task	createTask(long id, java.lang.String type, java.lang.String action, TaskId parentTaskId) Returns the task object that should be used to keep track of the processing of the request.
java.lang.String	getDescription() Returns optional description of the request to be displayed by the task manager
TaskId	getParentTask() Get a reference to the task that created this request.
void	readFrom(StreamInput in) Set this object's fields from a StreamInput.
void	setParentTask(java.lang.String parentTaskNode, long parentTaskId) Set a reference to task that caused this task to be run.
void	setParentTask(TaskId taskId) Set a reference to task that created this request.
void	writeTo(StreamOutput out) Write this object's fields to a StreamOutput.

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

Constructor Detail

TransportRequest

public TransportRequest()

Method Detail

setParentTask

public void setParentTask(java.lang.String parentTaskNode,
                          long parentTaskId)

Set a reference to task that caused this task to be run.

setParentTask

public void setParentTask(TaskId taskId)

Set a reference to task that created this request.

getParentTask

public TaskId getParentTask()

Get a reference to the task that created this request. Defaults to TaskId.EMPTY_TASK_ID, meaning "there is no parent".

createTask

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

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.

getDescription

public java.lang.String getDescription()

Returns optional description of the request to be displayed by the task manager

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 TransportMessage

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

Overrides:

writeTo in class TransportMessage

Throws:

java.io.IOException