org.elasticsearch.cluster.health

Class ClusterStateHealth

java.lang.Object

org.elasticsearch.cluster.health.ClusterStateHealth

All Implemented Interfaces:

Iterable<ClusterIndexHealth>, Streamable

public final class ClusterStateHealth
extends Object
implements Iterable<ClusterIndexHealth>, Streamable

Constructor Summary

Constructors

Constructor and Description
ClusterStateHealth(ClusterState clusterState) Creates a new ClusterStateHealth instance considering the current cluster state and all indices in the cluster.
ClusterStateHealth(ClusterState clusterState, String[] concreteIndices) Creates a new ClusterStateHealth instance considering the current cluster state and the provided index names.
ClusterStateHealth(int numberOfNodes, int numberOfDataNodes, int activeShards, int relocatingShards, int activePrimaryShards, int initializingShards, int unassignedShards, double activeShardsPercent, ClusterHealthStatus status, List<String> validationFailures, Map<String,ClusterIndexHealth> indices) Full constructor which is only intended to provide wire-compatibility for 2.x.
ClusterStateHealth(MetaData clusterMetaData, RoutingTable routingTables) Creates a new ClusterStateHealth instance based on cluster meta data and its routing table as a convenience.

Method Summary

Methods

Modifier and Type	Method and Description
int	getActivePrimaryShards()
int	getActiveShards()
double	getActiveShardsPercent()
Map<String,ClusterIndexHealth>	getIndices()
int	getInitializingShards()
int	getNumberOfDataNodes()
int	getNumberOfNodes()
int	getRelocatingShards()
ClusterHealthStatus	getStatus()
int	getUnassignedShards()
List<String>	getValidationFailures()
Iterator<ClusterIndexHealth>	iterator()
static ClusterStateHealth	readClusterHealth(StreamInput in)
void	readFrom(StreamInput in)
void	setStatus(ClusterHealthStatus status) Allows to explicitly override the derived cluster health status.
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Constructor Detail

ClusterStateHealth

public ClusterStateHealth(int numberOfNodes,
                  int numberOfDataNodes,
                  int activeShards,
                  int relocatingShards,
                  int activePrimaryShards,
                  int initializingShards,
                  int unassignedShards,
                  double activeShardsPercent,
                  ClusterHealthStatus status,
                  List<String> validationFailures,
                  Map<String,ClusterIndexHealth> indices)

Full constructor which is only intended to provide wire-compatibility for 2.x.

ClusterStateHealth

public ClusterStateHealth(MetaData clusterMetaData,
                  RoutingTable routingTables)

Creates a new ClusterStateHealth instance based on cluster meta data and its routing table as a convenience.

Parameters:

clusterMetaData - Current cluster meta data. Must not be null.

routingTables - Current routing table. Must not be null.

ClusterStateHealth

public ClusterStateHealth(ClusterState clusterState)

Creates a new ClusterStateHealth instance considering the current cluster state and all indices in the cluster.

Parameters:

clusterState - The current cluster state. Must not be null.

ClusterStateHealth

public ClusterStateHealth(ClusterState clusterState,
                  String[] concreteIndices)

Creates a new ClusterStateHealth instance considering the current cluster state and the provided index names.

Parameters:

clusterState - The current cluster state. Must not be null.

concreteIndices - An array of index names to consider. Must not be null but may be empty.

Method Detail

readClusterHealth

public static ClusterStateHealth readClusterHealth(StreamInput in)
                                            throws IOException

Throws:

IOException

getValidationFailures

public List<String> getValidationFailures()

getActiveShards

public int getActiveShards()

getRelocatingShards

public int getRelocatingShards()

getActivePrimaryShards

public int getActivePrimaryShards()

getInitializingShards

public int getInitializingShards()

getUnassignedShards

public int getUnassignedShards()

getNumberOfNodes

public int getNumberOfNodes()

getNumberOfDataNodes

public int getNumberOfDataNodes()

setStatus

public void setStatus(ClusterHealthStatus status)

Allows to explicitly override the derived cluster health status.

Implementation note: This setter is only here to ensure wire compatibility in 2.x. Starting from 3.0, ClusterStateHealth is (effectively) immutable and overrides are handled external to this class.

Parameters:

status - The override status. Must not be null.

getStatus

public ClusterHealthStatus getStatus()

getIndices

public Map<String,ClusterIndexHealth> getIndices()

getActiveShardsPercent

public double getActiveShardsPercent()

iterator

public Iterator<ClusterIndexHealth> iterator()

Specified by:

iterator in interface Iterable<ClusterIndexHealth>

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Throws:

IOException