Class ShardId

java.lang.Object
org.elasticsearch.index.shard.ShardId
All Implemented Interfaces:
java.lang.Comparable<ShardId>, Writeable, ToXContent, ToXContentFragment

public class ShardId
extends java.lang.Object
implements java.lang.Comparable<ShardId>, ToXContentFragment, Writeable
Allows for shard level components to be injected with the shard id.
  • Constructor Details

    • ShardId

      public ShardId​(Index index, int shardId)
    • ShardId

      public ShardId​(java.lang.String index, java.lang.String indexUUID, int shardId)
    • ShardId

      public ShardId​(StreamInput in) throws java.io.IOException
      Throws:
      java.io.IOException
  • Method Details

    • writeTo

      public void writeTo​(StreamOutput out) throws java.io.IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      java.io.IOException
    • getIndex

      public Index getIndex()
    • getIndexName

      public java.lang.String getIndexName()
    • id

      public int id()
    • getId

      public int getId()
    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object
    • fromString

      public static ShardId fromString​(java.lang.String shardIdString)
      Parse the string representation of this shardId back to an object. We lose index uuid information here, but since we use toString in rest responses, this is the best we can do to reconstruct the object on the client side.
    • equals

      public boolean equals​(java.lang.Object o)
      Overrides:
      equals in class java.lang.Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object
    • compareTo

      public int compareTo​(ShardId o)
      Specified by:
      compareTo in interface java.lang.Comparable<ShardId>
    • toXContent

      public XContentBuilder toXContent​(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
      Specified by:
      toXContent in interface ToXContent
      Throws:
      java.io.IOException