org.elasticsearch.action.admin.cluster.health

クラス 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

すべての実装されたインタフェース:

HasContext, HasContextAndHeaders, HasHeaders, Streamable, StatusToXContent, ToXContent

public class ClusterHealthResponse
extends ActionResponse
implements StatusToXContent

ネストされたクラスのサマリー

クラスから継承されたネストされたクラス/インタフェース org.elasticsearch.transport.TransportResponse

TransportResponse.Empty

インタフェースから継承されたネストされたクラス/インタフェース org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

フィールドのサマリー

クラスから継承されたフィールド org.elasticsearch.common.ContextAndHeaderHolder

headers

インタフェースから継承されたフィールド org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
ClusterHealthResponse(String clusterName, String[] concreteIndices, ClusterState clusterState) needed for plugins BWC
ClusterHealthResponse(String clusterName, String[] concreteIndices, ClusterState clusterState, int numberOfPendingTasks, int numberOfInFlightFetch, int delayedUnassignedShards, TimeValue taskMaxWaitingTime)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
int	getActivePrimaryShards()
int	getActiveShards()
double	getActiveShardsPercent() The percentage of active shards, should be 100% in a green system
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()
TimeValue	getTaskMaxWaitingTime()
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.
void	readFrom(StreamInput in)
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
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

クラスから継承されたメソッド org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

クラスから継承されたメソッド org.elasticsearch.common.ContextAndHeaderHolder

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

クラスから継承されたメソッド java.lang.Object

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

コンストラクタの詳細

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,
                             TimeValue taskMaxWaitingTime)

メソッドの詳細

getClusterName

public String getClusterName()

getValidationFailures

public List<String> getValidationFailures()

The validation failures on the cluster level (without index 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.

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.

パラメータ:

status - The override status. Must not be null.

getIndices

public Map<String,ClusterIndexHealth> getIndices()

getTaskMaxWaitingTime

public TimeValue getTaskMaxWaitingTime()

戻り値:

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 IOException

例外:

IOException

readFrom

public void readFrom(StreamInput in)
              throws IOException

定義:

readFrom インタフェース内 Streamable

オーバーライド:

readFrom クラス内 ActionResponse

例外:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

定義:

writeTo インタフェース内 Streamable

オーバーライド:

writeTo クラス内 ActionResponse

例外:

IOException

toString

public String toString()

オーバーライド:

toString クラス内 Object

status

public RestStatus status()

インタフェースからコピーされた説明: StatusToXContent

Returns the REST status to make sure it is returned correctly

定義:

status インタフェース内 StatusToXContent

toXContent

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

定義:

toXContent インタフェース内 ToXContent

例外:

IOException