Package org.elasticsearch.action.admin.cluster.health

Class ClusterHealthResponse

java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportResponse
org.elasticsearch.action.ActionResponse
org.elasticsearch.action.admin.cluster.health.ClusterHealthResponse
All Implemented Interfaces:
Writeable, org.elasticsearch.common.util.concurrent.RefCounted, StatusToXContentObject, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
public class ClusterHealthResponse
extends ActionResponse
implements StatusToXContentObject

  • Constructor Details

    • ClusterHealthResponse

      public ClusterHealthResponse()

    • ClusterHealthResponse

      public ClusterHealthResponse​(StreamInput in) throws java.io.IOException
      Throws:
      java.io.IOException

    • ClusterHealthResponse

      public ClusterHealthResponse​(java.lang.String clusterName, java.lang.String[] concreteIndices, ClusterState clusterState)
      needed for plugins BWC

    • ClusterHealthResponse

      public ClusterHealthResponse​(java.lang.String clusterName, java.lang.String[] concreteIndices, ClusterState clusterState, int numberOfPendingTasks, int numberOfInFlightFetch, int delayedUnassignedShards, org.elasticsearch.common.unit.TimeValue taskMaxWaitingTime)

  • Method Details

    • getClusterName

      public java.lang.String getClusterName()

    • 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.

    • setTimedOut

      public void setTimedOut​(boolean timedOut)

    • getStatus

      public ClusterHealthStatus getStatus()

    • setStatus

      public void setStatus​(ClusterHealthStatus status)
      Allows to explicitly override the derived cluster health status.
      Parameters:
      status - The override status. Must not be null.

    • getIndices

      public java.util.Map<java.lang.String,​ClusterIndexHealth> getIndices()

    • getTaskMaxWaitingTime

      public org.elasticsearch.common.unit.TimeValue getTaskMaxWaitingTime()
      Returns:
      The maximum wait time of all tasks in the queue

    • getActiveShardsPercent

      public double getActiveShardsPercent()
      The percentage of active shards, should be 100% in a green system

    • readResponseFrom

      public static ClusterHealthResponse readResponseFrom​(StreamInput in) throws java.io.IOException
      Throws:
      java.io.IOException

    • 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

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object

    • status

      public RestStatus status()
      Description copied from interface: StatusToXContentObject
      Returns the REST status to make sure it is returned correctly
      Specified by:
      status in interface StatusToXContentObject

    • toXContent

      public org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      java.io.IOException

    • fromXContent

      public static ClusterHealthResponse fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser)

    • equals

      public boolean equals​(java.lang.Object o)
      Overrides:
      equals in class java.lang.Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object