Package org.elasticsearch.action.search

Class SearchShard

java.lang.Object

org.elasticsearch.action.search.SearchShard

All Implemented Interfaces:

Comparable<SearchShard>

public final class SearchShard
extends Object
implements Comparable<SearchShard>

A class that encapsulates the ShardId and the cluster alias of a shard used during the search action.

Constructor Summary

Constructors

Constructor	Description
SearchShard(String clusterAlias, ShardId shardId)

Method Summary

Modifier and Type	Method	Description
int	compareTo(SearchShard o)
boolean	equals(Object o)
String	getClusterAlias()	Return the cluster alias if we are executing a cross cluster search request, null otherwise.
ShardId	getShardId()	Return the ShardId of this shard.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SearchShard

public SearchShard(@Nullable
 String clusterAlias,
 ShardId shardId)

Method Details

getClusterAlias

@Nullable
public String getClusterAlias()

Return the cluster alias if we are executing a cross cluster search request, null otherwise.

getShardId

public ShardId getShardId()

Return the ShardId of this shard.

compareTo

public int compareTo(SearchShard o)

Specified by:

compareTo in interface Comparable<SearchShard>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object