Module org.elasticsearch.server

Package org.elasticsearch.action.search

Class TransportSearchShardsAction

java.lang.Object

org.elasticsearch.action.support.TransportAction<SearchShardsRequest,SearchShardsResponse>

org.elasticsearch.action.search.TransportSearchShardsAction

public class TransportSearchShardsAction
extends TransportAction<SearchShardsRequest,SearchShardsResponse>

An internal search shards API performs the can_match phase and returns target shards of indices that might match a query.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME
static final RemoteClusterActionType<SearchShardsResponse>	REMOTE_TYPE
static final ActionType<SearchShardsResponse>	TYPE

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

actionName, logger, taskManager

Constructor Summary

Constructors

Constructor	Description
TransportSearchShardsAction(TransportService transportService, SearchService searchService, ActionFilters actionFilters, ClusterService clusterService, TransportSearchAction transportSearchAction, SearchTransportService searchTransportService, ProjectResolver projectResolver, IndexNameExpressionResolver indexNameExpressionResolver, SearchResponseMetrics searchResponseMetrics)

Method Summary

Modifier and Type	Method	Description
protected void	doExecute(Task task, SearchShardsRequest searchShardsRequest, ActionListener<SearchShardsResponse> listener)
void	searchShards(Task task, SearchShardsRequest searchShardsRequest, ActionListener<SearchShardsResponse> listener)	Notes that this method does not perform authorization for the search shards action.

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

execute, executeDirect, localOnly

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

TYPE

public static final ActionType<SearchShardsResponse> TYPE

REMOTE_TYPE

public static final RemoteClusterActionType<SearchShardsResponse> REMOTE_TYPE

Constructor Details

TransportSearchShardsAction

@Inject
public TransportSearchShardsAction(TransportService transportService,
 SearchService searchService,
 ActionFilters actionFilters,
 ClusterService clusterService,
 TransportSearchAction transportSearchAction,
 SearchTransportService searchTransportService,
 ProjectResolver projectResolver,
 IndexNameExpressionResolver indexNameExpressionResolver,
 SearchResponseMetrics searchResponseMetrics)

Method Details

doExecute

protected void doExecute(Task task,
 SearchShardsRequest searchShardsRequest,
 ActionListener<SearchShardsResponse> listener)

Specified by:

doExecute in class TransportAction<SearchShardsRequest,SearchShardsResponse>

searchShards

public void searchShards(Task task,
 SearchShardsRequest searchShardsRequest,
 ActionListener<SearchShardsResponse> listener)

Notes that this method does not perform authorization for the search shards action. Callers must ensure that the request was properly authorized before calling this method.