Package org.elasticsearch.index.shard

Class ShardId

java.lang.Object

org.elasticsearch.index.shard.ShardId

All Implemented Interfaces:

Comparable<ShardId>, Writeable, ToXContent, ToXContentFragment

public class ShardId
extends Object
implements 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.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.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ShardId(String index, 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(Object o)
static ShardId	fromString(String shardIdString)	Parse the string representation of this shardId back to an object.
int	getId()
Index	getIndex()
String	getIndexName()
int	hashCode()
int	id()
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.xcontent.ToXContentFragment

isFragment

Constructor Details

ShardId

public ShardId(Index index,
 int shardId)

ShardId

public ShardId(String index,
 String indexUUID,
 int shardId)

ShardId

public ShardId(StreamInput in)
        throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

getIndex

public Index getIndex()

getIndexName

public String getIndexName()

id

public int id()

getId

public int getId()

toString

public String toString()

Overrides:

toString in class Object

fromString

public static ShardId fromString(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(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(ShardId o)

Specified by:

compareTo in interface Comparable<ShardId>

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException