org.elasticsearch.transport

Class TransportRequest

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

All Implemented Interfaces:

HasContext, HasContextAndHeaders, HasHeaders, Streamable

Direct Known Subclasses:

ActionRequest, BytesTransportRequest, ChildTaskRequest, IndicesStore.ShardActiveRequest, InternalScrollSearchRequest, LocalAllocateDangledIndices.AllocateDangledRequest, MasterFaultDetection.MasterPingRequest, MembershipAction.JoinRequest, MembershipAction.LeaveRequest, MembershipAction.ValidateJoinRequest, NodeIndexDeletedAction.NodeIndexDeletedMessage, NodeIndexDeletedAction.NodeIndexStoreDeletedMessage, NodeMappingRefreshAction.NodeMappingRefreshRequest, NodesFaultDetection.PingRequest, QuerySearchRequest, RecoveryCleanFilesRequest, RecoveryFileChunkRequest, RecoveryFilesInfoRequest, RecoveryFinalizeRecoveryRequest, RecoveryPrepareForTranslogOperationsRequest, RecoveryTranslogOperationsRequest, RestoreService.UpdateIndexShardRestoreStatusRequest, SearchServiceTransportAction.ClearScrollContextsRequest, SearchServiceTransportAction.ScrollFreeContextRequest, ShardFetchRequest, ShardSearchTransportRequest, ShardStateAction.ShardRoutingEntry, SnapshotShardsService.UpdateIndexShardSnapshotStatusRequest, StartRecoveryRequest, SyncedFlushService.InFlightOpsRequest, SyncedFlushService.PreShardSyncedFlushRequest, SyncedFlushService.ShardSyncedFlushRequest, TransportRequest.Empty, UnicastZenPing.UnicastPingRequest, VerifyNodeRepositoryAction.VerifyNodeRepositoryRequest, ZenDiscovery.RejoinClusterRequest

public abstract class TransportRequest
extends TransportMessage<TransportRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TransportRequest.Empty

Field Summary

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Modifier	Constructor and Description
	TransportRequest()
protected	TransportRequest(TransportRequest 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.
String	getDescription() Returns optional description of the request to be displayed by the task manager

Methods inherited from class org.elasticsearch.transport.TransportMessage

readFrom, remoteAddress, remoteAddress, writeTo

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

TransportRequest

public TransportRequest()

TransportRequest

protected TransportRequest(TransportRequest request)

Method Detail

createTask

public 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. A request can override this method and return null to avoid being tracked by the task manager.

getDescription

public String getDescription()

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