IndexRoutingTable (Elasticsearch: Core 2.3.4 API)

java.lang.Object
- org.elasticsearch.cluster.AbstractDiffable<IndexRoutingTable>
- - org.elasticsearch.cluster.routing.IndexRoutingTable

All Implemented Interfaces:

Iterable<IndexShardRoutingTable>, Diffable<IndexRoutingTable>, StreamableReader<IndexRoutingTable>, Writeable<IndexRoutingTable>
```
public class IndexRoutingTable
extends AbstractDiffable<IndexRoutingTable>
implements Iterable<IndexShardRoutingTable>
```
The IndexRoutingTable represents routing information for a single index. The routing table maintains a list of all shards in the index. A single shard in this context has one more instances namely exactly one primary and 1 or more replicas. In other words, each instance of a shard is considered a replica while only one replica per shard is a primary replica. The primary replica can be seen as the "leader" of the shard acting as the primary entry point for operations on a specific shard.
Note: The term replica is not directly reflected in the routing table or in releated classes, replicas are represented as ShardRouting.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class IndexRoutingTable.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`IndexRoutingTable.Builder`

Field Summary

Fields
Modifier and Type Field and Description

static IndexRoutingTable PROTO

Fields
Modifier and Type	Field and Description
`static IndexRoutingTable`	`PROTO`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`allPrimaryShardsActive()` Returns `true` if all shards are primary and active.
`boolean`	`allPrimaryShardsUnassigned()` Returns `true` if all primary shards are in `ShardRoutingState.UNASSIGNED` state.
`static IndexRoutingTable.Builder`	`builder(String index)`
`boolean`	`equals(Object o)`
`String`	`getIndex()` Return the index id
`ImmutableOpenIntMap<IndexShardRoutingTable>`	`getShards()`
`GroupShardsIterator`	`groupByAllIt()` A groups shards iterator where each groups is a single `ShardRouting` and a group is created for each shard routing.
`GroupShardsIterator`	`groupByShardsIt()` A group shards iterator where each group (`ShardIterator` is an iterator across shard replication group.
`int`	`hashCode()`
`String`	`index()` Return the index id
`com.google.common.collect.UnmodifiableIterator<IndexShardRoutingTable>`	`iterator()`
`IndexRoutingTable`	`normalizeVersions()` creates a new `IndexRoutingTable` with all shard versions normalized
`int`	`numberOfNodesShardsAreAllocatedOn(String... excludedNodes)` Calculates the number of nodes that hold one or more shards of this index `IndexRoutingTable` excluding the nodes with the node ids give as the `excludedNodes` parameter.
`String`	`prettyPrint()`
`int`	`primaryShardsActive()` Calculates the number of primary shards in active state in routing table
`int`	`primaryShardsUnassigned()` Calculates the number of primary shards in the routing table the are in `ShardRoutingState.UNASSIGNED` state.
`ShardsIterator`	`randomAllActiveShardsIt()` Returns an unordered iterator over all active shards (including replicas).
`IndexRoutingTable`	`readFrom(StreamInput in)` Reads a copy of an object with the same type form the stream input The caller object remains unchanged.
`IndexShardRoutingTable`	`shard(int shardId)`
`ImmutableOpenIntMap<IndexShardRoutingTable>`	`shards()`
`List<ShardRouting>`	`shardsWithState(ShardRoutingState state)` Returns a `List` of shards that match one of the states listed in `states`
`void`	`validate()`
`List<String>`	`validate(IndexMetaData indexMetaData)` validate based on a meta data, returning failures found
`void`	`validate(RoutingTableValidation validation, MetaData metaData)`
`void`	`writeTo(StreamOutput out)` Writes the current object into the output stream out

Methods inherited from class org.elasticsearch.cluster.AbstractDiffable
diff, get, readDiffFrom, readDiffFrom

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - PROTO
```
public static final IndexRoutingTable PROTO
```
- Method Detail
  - index
```
public String index()
```
    Return the index id
    
    Returns:
    
    id of the index
  - getIndex
```
public String getIndex()
```
    Return the index id
    
    Returns:
    
    id of the index
  - normalizeVersions
```
public IndexRoutingTable normalizeVersions()
```
    creates a new IndexRoutingTable with all shard versions normalized
    
    Returns:
    
    new IndexRoutingTable
  - validate
```
public void validate(RoutingTableValidation validation,
                     MetaData metaData)
```
  - validate
```
public List<String> validate(IndexMetaData indexMetaData)
```
    validate based on a meta data, returning failures found
  - iterator
```
public com.google.common.collect.UnmodifiableIterator<IndexShardRoutingTable> iterator()
```
    Specified by:
    
    iterator in interface Iterable<IndexShardRoutingTable>
  - numberOfNodesShardsAreAllocatedOn
```
public int numberOfNodesShardsAreAllocatedOn(String... excludedNodes)
```
    Calculates the number of nodes that hold one or more shards of this index IndexRoutingTable excluding the nodes with the node ids give as the excludedNodes parameter.
    
    Parameters:
    
    excludedNodes - id of nodes that will be excluded
    
    Returns:
    
    number of distinct nodes this index has at least one shard allocated on
  - shards
```
public ImmutableOpenIntMap<IndexShardRoutingTable> shards()
```
  - getShards
```
public ImmutableOpenIntMap<IndexShardRoutingTable> getShards()
```
  - shard
```
public IndexShardRoutingTable shard(int shardId)
```
  - allPrimaryShardsActive
```
public boolean allPrimaryShardsActive()
```
    Returns true if all shards are primary and active. Otherwise false.
  - primaryShardsActive
```
public int primaryShardsActive()
```
    Calculates the number of primary shards in active state in routing table
    
    Returns:
    
    number of active primary shards
  - allPrimaryShardsUnassigned
```
public boolean allPrimaryShardsUnassigned()
```
    Returns true if all primary shards are in ShardRoutingState.UNASSIGNED state. Otherwise false.
  - primaryShardsUnassigned
```
public int primaryShardsUnassigned()
```
    Calculates the number of primary shards in the routing table the are in ShardRoutingState.UNASSIGNED state.
  - shardsWithState
```
public List<ShardRouting> shardsWithState(ShardRoutingState state)
```
    Returns a List of shards that match one of the states listed in states
    
    Parameters:
    
    state - ShardRoutingState to retrieve
    
    Returns:
    
    a List of shards that match one of the given states
  - randomAllActiveShardsIt
```
public ShardsIterator randomAllActiveShardsIt()
```
    Returns an unordered iterator over all active shards (including replicas).
  - groupByShardsIt
```
public GroupShardsIterator groupByShardsIt()
```
    A group shards iterator where each group (ShardIterator is an iterator across shard replication group.
  - groupByAllIt
```
public GroupShardsIterator groupByAllIt()
```
    A groups shards iterator where each groups is a single ShardRouting and a group is created for each shard routing.
    This basically means that components that use the GroupShardsIterator will iterate over *all* the shards (all the replicas) within the index.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - validate
```
public void validate()
              throws RoutingValidationException
```
    Throws:
    
    RoutingValidationException
  - readFrom
```
public IndexRoutingTable readFrom(StreamInput in)
                           throws IOException
```
    Description copied from interface: StreamableReader
    
    Reads a copy of an object with the same type form the stream input The caller object remains unchanged.
    
    Specified by:
    
    readFrom in interface StreamableReader<IndexRoutingTable>
    
    Throws:
    
    IOException
  - writeTo
```
public void writeTo(StreamOutput out)
             throws IOException
```
    Description copied from interface: Writeable
    
    Writes the current object into the output stream out
    
    Specified by:
    
    writeTo in interface Writeable<IndexRoutingTable>
    
    Throws:
    
    IOException
  - builder
```
public static IndexRoutingTable.Builder builder(String index)
```
  - prettyPrint
```
public String prettyPrint()
```

Class IndexRoutingTable

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class org.elasticsearch.cluster.AbstractDiffable

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

PROTO

Method Detail

index

getIndex

normalizeVersions

validate

validate

iterator

numberOfNodesShardsAreAllocatedOn

shards

getShards

shard

allPrimaryShardsActive

primaryShardsActive

allPrimaryShardsUnassigned

primaryShardsUnassigned

shardsWithState

randomAllActiveShardsIt

groupByShardsIt

groupByAllIt

equals

hashCode

validate

readFrom

writeTo

builder

prettyPrint