Streamable
, Writeable
, StatusToXContentObject
, ToXContent
, ToXContentObject
public class ClusterHealthResponse extends ActionResponse implements StatusToXContentObject
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
TransportResponse.Empty
Writeable.Reader<V>, Writeable.Writer<V>
EMPTY_PARAMS
Constructor | Description |
---|---|
ClusterHealthResponse(java.lang.String clusterName,
java.lang.String[] concreteIndices,
ClusterState clusterState) |
needed for plugins BWC
|
ClusterHealthResponse(java.lang.String clusterName,
java.lang.String[] concreteIndices,
ClusterState clusterState,
int numberOfPendingTasks,
int numberOfInFlightFetch,
int delayedUnassignedShards,
TimeValue taskMaxWaitingTime) |
Modifier and Type | Method | Description |
---|---|---|
int |
getActivePrimaryShards() |
|
int |
getActiveShards() |
|
double |
getActiveShardsPercent() |
The percentage of active shards, should be 100% in a green system
|
java.lang.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).
|
java.util.Map<java.lang.String,ClusterIndexHealth> |
getIndices() |
|
int |
getInitializingShards() |
|
int |
getNumberOfDataNodes() |
|
int |
getNumberOfInFlightFetch() |
|
int |
getNumberOfNodes() |
|
int |
getNumberOfPendingTasks() |
|
int |
getRelocatingShards() |
|
ClusterHealthStatus |
getStatus() |
|
TimeValue |
getTaskMaxWaitingTime() |
|
int |
getUnassignedShards() |
|
boolean |
isTimedOut() |
true if the waitForXXX has timeout out and did not match.
|
void |
readFrom(StreamInput in) |
Set this object's fields from a StreamInput.
|
static ClusterHealthResponse |
readResponseFrom(StreamInput in) |
|
void |
setStatus(ClusterHealthStatus status) |
Allows to explicitly override the derived cluster health status.
|
void |
setTimedOut(boolean timedOut) |
|
RestStatus |
status() |
Returns the REST status to make sure it is returned correctly
|
java.lang.String |
toString() |
|
XContentBuilder |
toXContent(XContentBuilder builder,
ToXContent.Params params) |
|
void |
writeTo(StreamOutput out) |
Write this object's fields to a StreamOutput.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
isFragment
remoteAddress, remoteAddress
public ClusterHealthResponse(java.lang.String clusterName, java.lang.String[] concreteIndices, ClusterState clusterState)
public ClusterHealthResponse(java.lang.String clusterName, java.lang.String[] concreteIndices, ClusterState clusterState, int numberOfPendingTasks, int numberOfInFlightFetch, int delayedUnassignedShards, TimeValue taskMaxWaitingTime)
public java.lang.String getClusterName()
public int getActiveShards()
public int getRelocatingShards()
public int getActivePrimaryShards()
public int getInitializingShards()
public int getUnassignedShards()
public int getNumberOfNodes()
public int getNumberOfDataNodes()
public int getNumberOfPendingTasks()
public int getNumberOfInFlightFetch()
public int getDelayedUnassignedShards()
public boolean isTimedOut()
public void setTimedOut(boolean timedOut)
public ClusterHealthStatus getStatus()
public void setStatus(ClusterHealthStatus status)
status
- The override status. Must not be null.public java.util.Map<java.lang.String,ClusterIndexHealth> getIndices()
public TimeValue getTaskMaxWaitingTime()
public double getActiveShardsPercent()
public static ClusterHealthResponse readResponseFrom(StreamInput in) throws java.io.IOException
java.io.IOException
public void readFrom(StreamInput in) throws java.io.IOException
Streamable
readFrom
in interface Streamable
readFrom
in class ActionResponse
java.io.IOException
public void writeTo(StreamOutput out) throws java.io.IOException
Streamable
writeTo
in interface Streamable
writeTo
in interface Writeable
writeTo
in class ActionResponse
java.io.IOException
public java.lang.String toString()
toString
in class java.lang.Object
public RestStatus status()
StatusToXContentObject
status
in interface StatusToXContentObject
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
toXContent
in interface ToXContent
java.io.IOException