Package org.elasticsearch.action.search
Class SearchShardIterator
org.elasticsearch.action.search.SearchShardIterator
- All Implemented Interfaces:
<SearchShardIterator>
,Countable
Extension of
PlainShardIterator
used in the search api, which also holds the OriginalIndices
of the search request (useful especially with cross-cluster search, as each cluster has its own set of original indices) as well as
the cluster alias.- See Also:
OriginalIndices
-
Constructor Summary
ConstructorDescriptionclusterAlias, ShardId shardId, <> targetNodeIds, OriginalIndices originalIndices, ShardSearchContextId searchContextId, org.elasticsearch.core.TimeValue searchContextKeepAlive)
clusterAlias, ShardId shardId, <ShardRouting> shards, OriginalIndices originalIndices)
Creates aPlainShardIterator
instance that iterates over a subset of the given shards this the a givenshardId
. -
Method Summary
Methods inherited from class java.lang.
, , , , , , , ,
-
Constructor Details
-
SearchShardIterator
public SearchShardIterator(@Nullable clusterAlias, ShardId shardId, <ShardRouting> shards, OriginalIndices originalIndices)Creates aPlainShardIterator
instance that iterates over a subset of the given shards this the a givenshardId
.- Parameters:
clusterAlias
- the alias of the cluster where the shard is locatedshardId
- shard id of the groupshards
- shards to iterateoriginalIndices
- the indices that the search request originally related to (before any rewriting happened)
-
SearchShardIterator
public SearchShardIterator(@Nullable clusterAlias, ShardId shardId, <> targetNodeIds, OriginalIndices originalIndices, ShardSearchContextId searchContextId, org.elasticsearch.core.TimeValue searchContextKeepAlive)
-
-
Method Details
-
getOriginalIndices
Returns the original indices associated with this shard iterator, specifically with the cluster that this shard belongs to. -
getClusterAlias
@Nullable public getClusterAlias()Returns the alias of the cluster where the shard is located. -
size
public int size() -
equals
public boolean equals( o)- Overrides:
in class
-
hashCode
public int hashCode()- Overrides:
in class
-
compareTo
- Specified by:
in interface
<SearchShardIterator>
-