org.elasticsearch.cluster.health

Class ClusterShardHealth

java.lang.Object

org.elasticsearch.cluster.health.ClusterShardHealth

All Implemented Interfaces:

Writeable

public final class ClusterShardHealth
extends java.lang.Object
implements Writeable

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Constructor Summary

Constructors

Constructor and Description
ClusterShardHealth(int shardId, IndexShardRoutingTable shardRoutingTable)
ClusterShardHealth(StreamInput in)

Method Summary

Modifier and Type	Method and Description
int	getActiveShards()
int	getId()
static ClusterHealthStatus	getInactivePrimaryHealth(ShardRouting shardRouting) Checks if an inactive primary shard should cause the cluster health to go RED.
int	getInitializingShards()
int	getRelocatingShards()
ClusterHealthStatus	getStatus()
int	getUnassignedShards()
boolean	isPrimaryActive()
void	writeTo(StreamOutput out) Write this into the StreamOutput.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClusterShardHealth

public ClusterShardHealth(int shardId,
                          IndexShardRoutingTable shardRoutingTable)

ClusterShardHealth

public ClusterShardHealth(StreamInput in)
                   throws java.io.IOException

Throws:

java.io.IOException

Method Detail

getId

public int getId()

getStatus

public ClusterHealthStatus getStatus()

getRelocatingShards

public int getRelocatingShards()

getActiveShards

public int getActiveShards()

isPrimaryActive

public boolean isPrimaryActive()

getInitializingShards

public int getInitializingShards()

getUnassignedShards

public int getUnassignedShards()

writeTo

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

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

java.io.IOException

getInactivePrimaryHealth

public static ClusterHealthStatus getInactivePrimaryHealth(ShardRouting shardRouting)

Checks if an inactive primary shard should cause the cluster health to go RED. An inactive primary shard in an index should cause the cluster health to be RED to make it visible that some of the existing data is unavailable. In case of index creation, snapshot restore or index shrinking, which are unexceptional events in the cluster lifecycle, cluster health should not turn RED for the time where primaries are still in the initializing state but go to YELLOW instead. However, in case of exceptional events, for example when the primary shard cannot be assigned to a node or initialization fails at some point, cluster health should still turn RED. NB: this method should *not* be called on active shards nor on non-primary shards.