Package org.elasticsearch.action.search

Class SearchShard

org.elasticsearch.action.search.SearchShard
All Implemented Interfaces:
<SearchShard>
public final class SearchShard extends implements <SearchShard>
A class that encapsulates the ShardId and the cluster alias of a shard used during the search action.

  • Constructor Summary

    Constructors
    Constructor
    Description
     clusterAlias, ShardId shardId)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    compareTo​(SearchShard o)
     
    boolean
     o)
     
    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()
     
    toString()
     

    Methods inherited from class java.lang.

    , , , , , , ,

  • Constructor Details

    • SearchShard

      public SearchShard​(@Nullable  clusterAlias, ShardId shardId)

  • Method Details

    • getClusterAlias

      @Nullable public  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:
       in interface <SearchShard>

    • equals

      public boolean equals​( o)
      Overrides:
       in class 

    • hashCode

      public int hashCode()
      Overrides:
       in class 

    • toString

      public  toString()
      Overrides:
       in class