org.elasticsearch.cluster.routing

Class ShardRouting

java.lang.Object

org.elasticsearch.cluster.routing.ShardRouting

All Implemented Interfaces:

Streamable, ToXContent

public final class ShardRouting
extends Object
implements Streamable, ToXContent

ShardRouting immutably encapsulates information about shard routings like id, state, version, etc.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field and Description
static long	UNAVAILABLE_EXPECTED_SHARD_SIZE Used if shard size is not available

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
ShardRouting(ShardRouting copy)
ShardRouting(ShardRouting copy, long version)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	active() Returns true iff the this shard is currently started or relocating to another node.
boolean	allocatedPostIndexCreate()
AllocationId	allocationId() An id that uniquely identifies an allocation.
boolean	assignedToNode() Returns true iff this shard is assigned to a node ie.
ShardRouting	buildTargetRelocatingShard() Creates a shard routing representing the target shard.
String	currentNodeId() The current node id the shard is allocated on.
boolean	equals(Object o)
boolean	equalsIgnoringMetaData(ShardRouting other) returns true if the current routing is identical to the other routing in all but meta fields, i.e., version and unassigned info
long	getExpectedShardSize() Returns the expected shard size for ShardRoutingState.RELOCATING and ShardRoutingState.INITIALIZING shards.
int	getId() The shard id.
String	getIndex() The index name.
int	hashCode()
int	id() The shard id.
String	index() The index name.
boolean	initializing() The shard is initializing (usually recovering either from peer shard or from gateway).
boolean	isRelocationSourceOf(ShardRouting other) returns true if the routing is the relocation source for the given routing
boolean	isRelocationTarget() Returns true if this shard is a relocation target for another shard (i.e., was created with buildTargetRelocatingShard()
boolean	isRelocationTargetOf(ShardRouting other) returns true if the routing is the relocation target of the given routing
boolean	isSameAllocation(ShardRouting other) returns true if this routing has the same allocation ID as another.
boolean	isSameShard(ShardRouting other) returns true if this routing has the same shardId as another
static ShardRouting	newUnassigned(String index, int shardId, RestoreSource restoreSource, boolean primary, UnassignedInfo unassignedInfo) Creates a new unassigned shard.
boolean	primary() Returns true iff this shard is a primary.
void	readFrom(StreamInput in)
void	readFrom(StreamInput in, String index, int shardId)
void	readFromThin(StreamInput in)
static ShardRouting	readShardRoutingEntry(StreamInput in)
static ShardRouting	readShardRoutingEntry(StreamInput in, String index, int shardId)
boolean	relocating() Returns true iff the this shard is currently relocating to another node.
String	relocatingNodeId() The relocating node id the shard is either relocating to or relocating from.
RestoreSource	restoreSource() Snapshot id and repository where this shard is being restored from
ShardId	shardId() The shard id.
ShardIterator	shardsIt() A shard iterator with just this shard in it.
String	shortSummary() A short description of the shard.
boolean	started() The shard is in started mode.
ShardRoutingState	state() The shard state.
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
boolean	unassigned() The shard is unassigned (not allocated to any node).
UnassignedInfo	unassignedInfo() Additional metadata on why the shard is/was unassigned.
void	updateUnassignedInfo(UnassignedInfo unassignedInfo)
long	version() The routing version associated with the shard.
void	writeTo(StreamOutput out)
void	writeToThin(StreamOutput out) Writes shard information to StreamOutput without writing index name and shard id

Methods inherited from class java.lang.Object

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

Field Detail

UNAVAILABLE_EXPECTED_SHARD_SIZE

public static final long UNAVAILABLE_EXPECTED_SHARD_SIZE

Used if shard size is not available

See Also:

Constant Field Values

Constructor Detail

ShardRouting

public ShardRouting(ShardRouting copy)

ShardRouting

public ShardRouting(ShardRouting copy,
            long version)

Method Detail

newUnassigned

public static ShardRouting newUnassigned(String index,
                         int shardId,
                         RestoreSource restoreSource,
                         boolean primary,
                         UnassignedInfo unassignedInfo)

Creates a new unassigned shard.

index

public String index()

The index name.

getIndex

public String getIndex()

The index name.

id

public int id()

The shard id.

getId

public int getId()

The shard id.

version

public long version()

The routing version associated with the shard.

unassigned

public boolean unassigned()

The shard is unassigned (not allocated to any node).

initializing

public boolean initializing()

The shard is initializing (usually recovering either from peer shard or from gateway).

active

public boolean active()

Returns true iff the this shard is currently started or relocating to another node. Otherwise false

started

public boolean started()

The shard is in started mode.

relocating

public boolean relocating()

Returns true iff the this shard is currently relocating to another node. Otherwise false

See Also:

ShardRoutingState.RELOCATING

assignedToNode

public boolean assignedToNode()

Returns true iff this shard is assigned to a node ie. not unassigned. Otherwise false

currentNodeId

public String currentNodeId()

The current node id the shard is allocated on.

relocatingNodeId

public String relocatingNodeId()

The relocating node id the shard is either relocating to or relocating from.

buildTargetRelocatingShard

public ShardRouting buildTargetRelocatingShard()

Creates a shard routing representing the target shard. The target shard routing will be the INITIALIZING state and have relocatingNodeId set to the source node.

restoreSource

public RestoreSource restoreSource()

Snapshot id and repository where this shard is being restored from

unassignedInfo

@Nullable
public UnassignedInfo unassignedInfo()

Additional metadata on why the shard is/was unassigned. The metadata is kept around until the shard moves to STARTED.

allocationId

@Nullable
public AllocationId allocationId()

An id that uniquely identifies an allocation.

primary

public boolean primary()

Returns true iff this shard is a primary.

state

public ShardRoutingState state()

The shard state.

shardId

public ShardId shardId()

The shard id.

allocatedPostIndexCreate

public boolean allocatedPostIndexCreate()

shardsIt

public ShardIterator shardsIt()

A shard iterator with just this shard in it.

readShardRoutingEntry

public static ShardRouting readShardRoutingEntry(StreamInput in)
                                          throws IOException

Throws:

IOException

readShardRoutingEntry

public static ShardRouting readShardRoutingEntry(StreamInput in,
                                 String index,
                                 int shardId)
                                          throws IOException

Throws:

IOException

readFrom

public void readFrom(StreamInput in,
            String index,
            int shardId)
              throws IOException

Throws:

IOException

readFromThin

public void readFromThin(StreamInput in)
                  throws IOException

Throws:

IOException

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Throws:

IOException

writeToThin

public void writeToThin(StreamOutput out)
                 throws IOException

Writes shard information to StreamOutput without writing index name and shard id

Parameters:

out - StreamOutput to write shard information to

Throws:

IOException - if something happens during write

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Throws:

IOException

updateUnassignedInfo

public void updateUnassignedInfo(UnassignedInfo unassignedInfo)

isSameShard

public boolean isSameShard(ShardRouting other)

returns true if this routing has the same shardId as another

isSameAllocation

public boolean isSameAllocation(ShardRouting other)

returns true if this routing has the same allocation ID as another.

Note: if both shard routing has a null as their allocationId(), this method returns false as the routing describe no allocation at all..

isRelocationTarget

public boolean isRelocationTarget()

Returns true if this shard is a relocation target for another shard (i.e., was created with buildTargetRelocatingShard()

isRelocationTargetOf

public boolean isRelocationTargetOf(ShardRouting other)

returns true if the routing is the relocation target of the given routing

isRelocationSourceOf

public boolean isRelocationSourceOf(ShardRouting other)

returns true if the routing is the relocation source for the given routing

equalsIgnoringMetaData

public boolean equalsIgnoringMetaData(ShardRouting other)

returns true if the current routing is identical to the other routing in all but meta fields, i.e., version and unassigned info

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

shortSummary

public String shortSummary()

A short description of the shard.

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

getExpectedShardSize

public long getExpectedShardSize()

Returns the expected shard size for ShardRoutingState.RELOCATING and ShardRoutingState.INITIALIZING shards. If it's size is not available -1L will be returned.