org.elasticsearch.action.admin.cluster.health

Class ClusterHealthResponse

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportResponse>

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.admin.cluster.health.ClusterHealthResponse

All Implemented Interfaces:

Iterable<ClusterIndexHealth>, HasContext, HasContextAndHeaders, HasHeaders, Streamable, ToXContent

public class ClusterHealthResponse
extends ActionResponse
implements Iterable<ClusterIndexHealth>, ToXContent

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportResponse

TransportResponse.Empty

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
ClusterHealthResponse(String clusterName, String[] concreteIndices, ClusterState clusterState) needed for plugins BWC
ClusterHealthResponse(String clusterName, String[] concreteIndices, ClusterState clusterState, int numberOfPendingTasks, int numberOfInFlightFetch, int delayedUnassignedShards)

Method Summary

Modifier and Type	Method and Description
int	getActivePrimaryShards()
int	getActiveShards()
List<String>	getAllValidationFailures() All the validation failures, including index level validation failures.
String	getClusterName()
int	getDelayedUnassignedShards() The number of unassigned shards that are currently being delayed (for example, due to node leaving the cluster and waiting for a timeout for the node to come back in order to allocate the shards back to it).
Map<String,ClusterIndexHealth>	getIndices()
int	getInitializingShards()
int	getNumberOfDataNodes()
int	getNumberOfInFlightFetch()
int	getNumberOfNodes()
int	getNumberOfPendingTasks()
int	getRelocatingShards()
ClusterHealthStatus	getStatus()
int	getUnassignedShards()
List<String>	getValidationFailures() The validation failures on the cluster level (without index validation failures).
boolean	isTimedOut() true if the waitForXXX has timeout out and did not match.
Iterator<ClusterIndexHealth>	iterator()
void	readFrom(StreamInput in)
static ClusterHealthResponse	readResponseFrom(StreamInput in)
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.transport.TransportMessage

putHeader, remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putInContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ClusterHealthResponse

public ClusterHealthResponse(String clusterName,
                             String[] concreteIndices,
                             ClusterState clusterState)

needed for plugins BWC

ClusterHealthResponse

public ClusterHealthResponse(String clusterName,
                             String[] concreteIndices,
                             ClusterState clusterState,
                             int numberOfPendingTasks,
                             int numberOfInFlightFetch,
                             int delayedUnassignedShards)

Method Detail

getClusterName

public String getClusterName()

getValidationFailures

public List<String> getValidationFailures()

The validation failures on the cluster level (without index validation failures).

getAllValidationFailures

public List<String> getAllValidationFailures()

All the validation failures, including index level validation failures.

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()

getNumberOfPendingTasks

public int getNumberOfPendingTasks()

getNumberOfInFlightFetch

public int getNumberOfInFlightFetch()

getDelayedUnassignedShards

public int getDelayedUnassignedShards()

The number of unassigned shards that are currently being delayed (for example, due to node leaving the cluster and waiting for a timeout for the node to come back in order to allocate the shards back to it).

isTimedOut

public boolean isTimedOut()

true if the waitForXXX has timeout out and did not match.

getStatus

public ClusterHealthStatus getStatus()

getIndices

public Map<String,ClusterIndexHealth> getIndices()

iterator

public Iterator<ClusterIndexHealth> iterator()

Specified by:

iterator in interface Iterable<ClusterIndexHealth>

readResponseFrom

public static ClusterHealthResponse readResponseFrom(StreamInput in)
                                              throws IOException

Throws:

IOException

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionResponse

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class ActionResponse

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException