Module org.elasticsearch.server
Class ClusterStateResponse
java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportResponse
org.elasticsearch.action.ActionResponse
org.elasticsearch.action.admin.cluster.state.ClusterStateResponse
- All Implemented Interfaces:
Writeable,RefCounted
The response for getting the cluster state.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.action.ActionResponse
ActionResponse.EmptyNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
Fields inherited from interface org.elasticsearch.core.RefCounted
ALWAYS_REFERENCED -
Constructor Summary
ConstructorsConstructorDescriptionClusterStateResponse(ClusterName clusterName, ClusterState clusterState, boolean waitForTimedOut) -
Method Summary
Modifier and TypeMethodDescriptionbooleanThe name of the cluster.getState()The requested cluster state.inthashCode()booleanReturns whether the request timed out waiting for a cluster state with a metadata version equal or higher than the specified metadata.voidwriteTo(StreamOutput out) Write this into the StreamOutput.Methods inherited from class org.elasticsearch.transport.TransportMessage
decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRefMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.elasticsearch.core.RefCounted
mustIncRef
-
Constructor Details
-
ClusterStateResponse
- Throws:
IOException
-
ClusterStateResponse
public ClusterStateResponse(ClusterName clusterName, ClusterState clusterState, boolean waitForTimedOut)
-
-
Method Details
-
getState
The requested cluster state. Only the parts of the cluster state that were requested are included in the returnedClusterStateinstance. -
getClusterName
The name of the cluster. -
isWaitForTimedOut
public boolean isWaitForTimedOut()Returns whether the request timed out waiting for a cluster state with a metadata version equal or higher than the specified metadata. -
writeTo
Description copied from interface:WriteableWrite this into the StreamOutput.- Throws:
IOException
-
equals
-
hashCode
public int hashCode()
-