Package org.elasticsearch.index.shard

Class ShardId

java.lang.Object

org.elasticsearch.index.shard.ShardId

All Implemented Interfaces:

java.lang.Comparable<ShardId>, Streamable, ToXContent, ToXContentFragment

public class ShardId
extends java.lang.Object
implements Streamable, java.lang.Comparable<ShardId>, ToXContentFragment

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

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(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()
void	readFrom(StreamInput in)	Set this object's fields from a StreamInput.
static ShardId	readShardId(StreamInput in)
java.lang.String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this object's fields to a StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.io.stream.Streamable

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)

Method Detail

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

readShardId

public static ShardId readShardId(StreamInput in)
                           throws java.io.IOException

Throws:

java.io.IOException

readFrom

public void readFrom(StreamInput in)
              throws java.io.IOException

Description copied from interface: Streamable

Set this object's fields from a StreamInput.

Specified by:

readFrom in interface Streamable

Throws:

java.io.IOException

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Streamable

Write this object's fields to a StreamOutput.

Specified by:

writeTo in interface Streamable

Throws:

java.io.IOException

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