Package org.elasticsearch.index.shard
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.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
-
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
-
Field Summary
-
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
-
Constructor Summary
Constructors Constructor Description ShardId(java.lang.String index, java.lang.String indexUUID, int shardId)
ShardId(StreamInput in)
ShardId(Index index, int shardId)
-
Method Summary
Modifier and Type Method Description int
compareTo(ShardId o)
boolean
equals(java.lang.Object o)
static ShardId
fromString(java.lang.String shardIdString)
Parse the string representation of this shardId back to an object.int
getId()
Index
getIndex()
java.lang.String
getIndexName()
int
hashCode()
int
id()
java.lang.String
toString()
XContentBuilder
toXContent(XContentBuilder builder, ToXContent.Params params)
void
writeTo(StreamOutput out)
Write this into the StreamOutput.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment
isFragment
-
-
-
-
Constructor Detail
-
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 Detail
-
writeTo
public void writeTo(StreamOutput out) throws java.io.IOException
Description copied from interface:Writeable
Write this into the StreamOutput.
-
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 classjava.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 classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
compareTo
public int compareTo(ShardId o)
- Specified by:
compareTo
in interfacejava.lang.Comparable<ShardId>
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
- Specified by:
toXContent
in interfaceToXContent
- Throws:
java.io.IOException
-
-