Package org.elasticsearch.action.explain

Class TransportExplainAction

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

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

org.elasticsearch.action.support.single.shard.TransportSingleShardAction<ExplainRequest,ExplainResponse>

org.elasticsearch.action.explain.TransportExplainAction

public class TransportExplainAction
extends TransportSingleShardAction<ExplainRequest,ExplainResponse>

Explain transport action. Computes the explain on the targeted shard.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.action.support.single.shard.TransportSingleShardAction

TransportSingleShardAction.InternalRequest

Field Summary

Fields inherited from class org.elasticsearch.common.component.AbstractComponent

deprecationLogger, logger, settings

Fields inherited from class org.elasticsearch.action.support.TransportAction

actionName, indexNameExpressionResolver, taskManager, threadPool

Fields inherited from class org.elasticsearch.action.support.single.shard.TransportSingleShardAction

clusterService, transportService

Constructor Summary

Constructors

Constructor	Description
TransportExplainAction(Settings settings, ThreadPool threadPool, ClusterService clusterService, TransportService transportService, SearchService searchService, ActionFilters actionFilters, IndexNameExpressionResolver indexNameExpressionResolver)

Method Summary

Modifier and Type	Method	Description
protected void	doExecute(ExplainRequest request, ActionListener<ExplainResponse> listener)
protected ExplainResponse	newResponse()
protected boolean	resolveIndex(ExplainRequest request)
protected void	resolveRequest(ClusterState state, TransportSingleShardAction.InternalRequest request)
protected ExplainResponse	shardOperation(ExplainRequest request, ShardId shardId)
protected ShardIterator	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)

Methods inherited from class org.elasticsearch.common.component.AbstractComponent

logDeprecatedSetting, logRemovedSetting, nodeName

Methods inherited from class java.lang.Object

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

Methods inherited from class org.elasticsearch.action.support.TransportAction

doExecute, execute, execute, execute, execute

Methods inherited from class org.elasticsearch.action.support.single.shard.TransportSingleShardAction

checkGlobalBlock, checkRequestBlock, isSubAction

Constructor Detail

TransportExplainAction

@Inject
public TransportExplainAction(Settings settings,
                              ThreadPool threadPool,
                              ClusterService clusterService,
                              TransportService transportService,
                              SearchService searchService,
                              ActionFilters actionFilters,
                              IndexNameExpressionResolver indexNameExpressionResolver)

Method Detail

doExecute

protected void doExecute(ExplainRequest request,
                         ActionListener<ExplainResponse> listener)

Overrides:

doExecute in class TransportSingleShardAction<ExplainRequest,ExplainResponse>

resolveIndex

protected boolean resolveIndex(ExplainRequest request)

Specified by:

resolveIndex in class TransportSingleShardAction<ExplainRequest,ExplainResponse>

resolveRequest

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

Overrides:

resolveRequest in class TransportSingleShardAction<ExplainRequest,ExplainResponse>

shardOperation

protected ExplainResponse shardOperation(ExplainRequest request,
                                         ShardId shardId)
                                  throws java.io.IOException

Specified by:

shardOperation in class TransportSingleShardAction<ExplainRequest,ExplainResponse>

Throws:

java.io.IOException

newResponse

protected ExplainResponse newResponse()

Specified by:

newResponse in class TransportSingleShardAction<ExplainRequest,ExplainResponse>

shards

protected ShardIterator shards(ClusterState state,
                               TransportSingleShardAction.InternalRequest request)

Description copied from class: TransportSingleShardAction

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

Specified by:

shards in class TransportSingleShardAction<ExplainRequest,ExplainResponse>