org.elasticsearch.action.support.single.shard

クラス TransportSingleShardAction<Request extends SingleShardRequest,Response extends ActionResponse>

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.action.support.TransportAction<Request,Response>

org.elasticsearch.action.support.single.shard.TransportSingleShardAction<Request,Response>

直系の既知のサブクラス:

TransportAnalyzeAction, TransportExplainAction, TransportGetAction, TransportGetFieldMappingsIndexAction, TransportShardMultiGetAction, TransportShardMultiPercolateAction, TransportShardMultiTermsVectorAction, TransportTermVectorsAction

public abstract class TransportSingleShardAction<Request extends SingleShardRequest,Response extends ActionResponse>
extends TransportAction<Request,Response>

A base class for operations that need to perform a read operation on a single shard copy. If the operation fails, the read operation can be performed on other shard copies. Concrete implementations can provide their own list of candidate shards to try the read operation on.

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	クラスと説明
protected class	TransportSingleShardAction.InternalRequest Internal request class that gets built on each node.

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected ClusterService	clusterService
protected TransportService	transportService

クラスから継承されたフィールド org.elasticsearch.action.support.TransportAction

actionName, indexNameExpressionResolver, parseFieldMatcher, taskManager, threadPool

クラスから継承されたフィールド org.elasticsearch.common.component.AbstractComponent

deprecationLogger, logger, settings

コンストラクタのサマリー

コンストラクタ

修飾子	コンストラクタと説明
protected	TransportSingleShardAction(Settings settings, String actionName, ThreadPool threadPool, ClusterService clusterService, TransportService transportService, ActionFilters actionFilters, IndexNameExpressionResolver indexNameExpressionResolver, Class<Request> request, String executor)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected ClusterBlockException	checkGlobalBlock(ClusterState state)
protected ClusterBlockException	checkRequestBlock(ClusterState state, TransportSingleShardAction.InternalRequest request)
protected void	doExecute(Request request, ActionListener<Response> listener)
protected boolean	isSubAction() Tells whether the action is a main one or a subaction.
protected abstract Response	newResponse()
protected abstract boolean	resolveIndex(Request request)
protected void	resolveRequest(ClusterState state, TransportSingleShardAction.InternalRequest request)
protected abstract Response	shardOperation(Request request, ShardId shardId)
protected abstract ShardsIterator	shards(ClusterState state, TransportSingleShardAction.InternalRequest request) Returns the candidate shards to execute the operation on or null the execute the operation locally (the node that received the request)

クラスから継承されたメソッド org.elasticsearch.action.support.TransportAction

doExecute, execute, execute, execute, execute

クラスから継承されたメソッド org.elasticsearch.common.component.AbstractComponent

logDeprecatedSetting, logRemovedSetting, nodeName

クラスから継承されたメソッド java.lang.Object

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

フィールドの詳細

clusterService

protected final ClusterService clusterService

transportService

protected final TransportService transportService

コンストラクタの詳細

TransportSingleShardAction

protected TransportSingleShardAction(Settings settings,
                                     String actionName,
                                     ThreadPool threadPool,
                                     ClusterService clusterService,
                                     TransportService transportService,
                                     ActionFilters actionFilters,
                                     IndexNameExpressionResolver indexNameExpressionResolver,
                                     Class<Request> request,
                                     String executor)

メソッドの詳細

isSubAction

protected boolean isSubAction()

Tells whether the action is a main one or a subaction. Used to decide whether we need to register the main transport handler. In fact if the action is a subaction, its execute method will be called locally to its parent action.

doExecute

protected void doExecute(Request request,
                         ActionListener<Response> listener)

定義:

doExecute クラス内 TransportAction<Request extends SingleShardRequest,Response extends ActionResponse>

shardOperation

protected abstract Response shardOperation(Request request,
                                           ShardId shardId)

newResponse

protected abstract Response newResponse()

resolveIndex

protected abstract boolean resolveIndex(Request request)

checkGlobalBlock

protected ClusterBlockException checkGlobalBlock(ClusterState state)

checkRequestBlock

protected ClusterBlockException checkRequestBlock(ClusterState state,
                                                  TransportSingleShardAction.InternalRequest request)

resolveRequest

protected void resolveRequest(ClusterState state,
                              TransportSingleShardAction.InternalRequest request)

shards

@Nullable
protected abstract ShardsIterator shards(ClusterState state,
                                                   TransportSingleShardAction.InternalRequest request)

Returns the candidate shards to execute the operation on or null the execute the operation locally (the node that received the request)