org.elasticsearch.cluster.routing

Interface ShardRouting

All Superinterfaces:

Serializable, Streamable, ToXContent

All Known Implementing Classes:

ImmutableShardRouting, MutableShardRouting

public interface ShardRouting
extends Streamable, Serializable, ToXContent

Shard routing represents the state of a shard instance allocated in the cluster.

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

Method Summary

Modifier and Type	Method and Description
boolean	active() Returns true iff the this shard is currently started or relocating to another node.
boolean	assignedToNode() Returns true iff this shard is assigned to a node ie.
String	currentNodeId() The current node id the shard is allocated on.
int	getId() The shard id.
String	getIndex() The index name.
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	primary() Returns true iff this shard is a primary.
void	readFromThin(StreamInput in)
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.
ShardRouting	targetRoutingIfRelocating() If the shard is relocating, return a shard routing representing the target shard or null o.w.
boolean	unassigned() The shard is unassigned (not allocated to any node).
UnassignedInfo	unassignedInfo() Additional metadata on why the shard is/was unassigned.
long	version() The routing version associated with the shard.
void	writeToThin(StreamOutput out) Does not write index name and shard id

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

readFrom, writeTo

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

toXContent

Method Detail

shardId

ShardId shardId()

The shard id.

index

String index()

The index name.

getIndex

String getIndex()

The index name.

id

int id()

The shard id.

getId

int getId()

The shard id.

version

long version()

The routing version associated with the shard.

state

ShardRoutingState state()

The shard state.

unassigned

boolean unassigned()

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

initializing

boolean initializing()

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

started

boolean started()

The shard is in started mode.

relocating

boolean relocating()

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

See Also:

ShardRoutingState.RELOCATING

active

boolean active()

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

assignedToNode

boolean assignedToNode()

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

currentNodeId

String currentNodeId()

The current node id the shard is allocated on.

relocatingNodeId

String relocatingNodeId()

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

targetRoutingIfRelocating

ShardRouting targetRoutingIfRelocating()

If the shard is relocating, return a shard routing representing the target shard or null o.w. The target shard routing will be the INITIALIZING state and have relocatingNodeId set to the source node.

restoreSource

RestoreSource restoreSource()

Snapshot id and repository where this shard is being restored from

unassignedInfo

UnassignedInfo unassignedInfo()

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

primary

boolean primary()

Returns true iff this shard is a primary.

shortSummary

String shortSummary()

A short description of the shard.

shardsIt

ShardIterator shardsIt()

A shard iterator with just this shard in it.

writeToThin

void writeToThin(StreamOutput out)
          throws IOException

Does not write index name and shard id

Throws:

IOException

readFromThin

void readFromThin(StreamInput in)
           throws ClassNotFoundException,
                  IOException

Throws:

ClassNotFoundException

IOException