Module org.elasticsearch.server

Package org.elasticsearch.action.search

Class SearchProgressListener

java.lang.Object

org.elasticsearch.action.search.SearchProgressListener

Direct Known Subclasses:

CCSSingleCoordinatorSearchProgressListener, SearchProgressActionListener

public abstract class SearchProgressListener
extends Object

A listener that allows to track progress of the TransportSearchAction.

Field Summary

Fields

Modifier and Type	Field	Description
static final SearchProgressListener	NOOP

Constructor Summary

Constructors

Constructor	Description
SearchProgressListener()

Method Summary

Modifier and Type	Method	Description
protected final void	notifyFinalReduce(List<SearchShard> shards, org.apache.lucene.search.TotalHits totalHits, InternalAggregations aggs, int reducePhase)
protected void	onClusterResponseMinimizeRoundtrips(String clusterAlias, SearchResponse searchResponse)	Indicates that a cluster has finished a search operation.
protected void	onFetchFailure(int shardIndex, SearchShardTarget shardTarget, Exception exc)	Executed when a shard reports a fetch failure.
protected void	onFetchResult(int shardIndex)	Executed when a shard returns a fetch result.
protected void	onFinalReduce(List<SearchShard> shards, org.apache.lucene.search.TotalHits totalHits, InternalAggregations aggs, int reducePhase)	Executed once when the final reduce is created.
protected void	onListShards(List<SearchShard> shards, List<SearchShard> skippedShards, SearchResponse.Clusters clusters, boolean fetchPhase, TransportSearchAction.SearchTimeProvider timeProvider)	Executed when shards are ready to be queried.
protected void	onPartialReduce(List<SearchShard> shards, org.apache.lucene.search.TotalHits totalHits, InternalAggregations aggs, int reducePhase)	Executed when a partial reduce is created.
protected void	onQueryFailure(int shardIndex, SearchShardTarget shardTarget, Exception exc)	Executed when a shard reports a query failure.
protected void	onQueryResult(int shardIndex, QuerySearchResult queryResult)	Executed when a shard returns a query result.

Methods inherited from class java.lang.Object

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

Field Details

NOOP

public static final SearchProgressListener NOOP

Constructor Details

SearchProgressListener

public SearchProgressListener()

Method Details

onListShards

protected void onListShards(List<SearchShard> shards,
 List<SearchShard> skippedShards,
 SearchResponse.Clusters clusters,
 boolean fetchPhase,
 TransportSearchAction.SearchTimeProvider timeProvider)

Executed when shards are ready to be queried.

Parameters:

shards - The list of shards to query.

skippedShards - The list of skipped shards.

clusters - The statistics for remote clusters included in the search.

fetchPhase - true if the search needs a fetch phase, false otherwise.

timeProvider - absolute and relative time provider for this search

onQueryResult

protected void onQueryResult(int shardIndex,
 QuerySearchResult queryResult)

Executed when a shard returns a query result.

Parameters:

shardIndex - The index of the shard in the list provided by onListShards(java.util.List<org.elasticsearch.action.search.SearchShard>, java.util.List<org.elasticsearch.action.search.SearchShard>, org.elasticsearch.action.search.SearchResponse.Clusters, boolean, org.elasticsearch.action.search.TransportSearchAction.SearchTimeProvider) )}.

queryResult -

onQueryFailure

protected void onQueryFailure(int shardIndex,
 SearchShardTarget shardTarget,
 Exception exc)

Executed when a shard reports a query failure.

Parameters:

shardIndex - The index of the shard in the list provided by onListShards(java.util.List<org.elasticsearch.action.search.SearchShard>, java.util.List<org.elasticsearch.action.search.SearchShard>, org.elasticsearch.action.search.SearchResponse.Clusters, boolean, org.elasticsearch.action.search.TransportSearchAction.SearchTimeProvider))}.

shardTarget - The last shard target that thrown an exception.

exc - The cause of the failure.

onPartialReduce

protected void onPartialReduce(List<SearchShard> shards,
 org.apache.lucene.search.TotalHits totalHits,
 InternalAggregations aggs,
 int reducePhase)

Executed when a partial reduce is created. The number of partial reduce can be controlled via SearchRequest.setBatchedReduceSize(int).

Parameters:

shards - The list of shards that are part of this reduce.

totalHits - The total number of hits in this reduce.

aggs - The partial result for aggregations.

reducePhase - The version number for this reduce.

onFinalReduce

protected void onFinalReduce(List<SearchShard> shards,
 org.apache.lucene.search.TotalHits totalHits,
 InternalAggregations aggs,
 int reducePhase)

Executed once when the final reduce is created.

Parameters:

shards - The list of shards that are part of this reduce.

totalHits - The total number of hits in this reduce.

aggs - The final result for aggregations.

reducePhase - The version number for this reduce.

onFetchResult

protected void onFetchResult(int shardIndex)

Executed when a shard returns a fetch result.

Parameters:

shardIndex - The index of the shard in the list provided by onListShards(java.util.List<org.elasticsearch.action.search.SearchShard>, java.util.List<org.elasticsearch.action.search.SearchShard>, org.elasticsearch.action.search.SearchResponse.Clusters, boolean, org.elasticsearch.action.search.TransportSearchAction.SearchTimeProvider))}.

onFetchFailure

protected void onFetchFailure(int shardIndex,
 SearchShardTarget shardTarget,
 Exception exc)

Executed when a shard reports a fetch failure.

Parameters:

shardIndex - The index of the shard in the list provided by onListShards(java.util.List<org.elasticsearch.action.search.SearchShard>, java.util.List<org.elasticsearch.action.search.SearchShard>, org.elasticsearch.action.search.SearchResponse.Clusters, boolean, org.elasticsearch.action.search.TransportSearchAction.SearchTimeProvider))}.

shardTarget - The last shard target that thrown an exception.

exc - The cause of the failure.

onClusterResponseMinimizeRoundtrips

protected void onClusterResponseMinimizeRoundtrips(String clusterAlias,
 SearchResponse searchResponse)

Indicates that a cluster has finished a search operation. Used for CCS minimize_roundtrips=true only.

Parameters:

clusterAlias - alias of cluster that has finished a search operation and returned a SearchResponse. The cluster alias for the local cluster is RemoteClusterAware.LOCAL_CLUSTER_GROUP_KEY.

searchResponse - SearchResponse from cluster 'clusterAlias'

notifyFinalReduce

protected final void notifyFinalReduce(List<SearchShard> shards,
 org.apache.lucene.search.TotalHits totalHits,
 InternalAggregations aggs,
 int reducePhase)