ClusterStateResponse (server 7.5.2 API)

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
```
public class ClusterStateResponse
extends ActionResponse
```
The response for getting the cluster state.

Nested Class Summary
- Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportResponse
  TransportResponse.Empty
- Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
  Writeable.Reader<V>, Writeable.Writer<V>

Constructor Summary

Constructors
Constructor	Description
`ClusterStateResponse(ClusterName clusterName, ClusterState clusterState, boolean waitForTimedOut)`
`ClusterStateResponse(StreamInput in)`

Method Summary

Modifier and Type	Method	Description
`boolean`	`equals(java.lang.Object o)`
`ClusterName`	`getClusterName()`	The name of the cluster.
`ClusterState`	`getState()`	The requested cluster state.
`int`	`hashCode()`
`boolean`	`isWaitForTimedOut()`	Returns whether the request timed out waiting for a cluster state with a metadata version equal or higher than the specified metadata.
`void`	`writeTo(StreamOutput out)`	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.transport.TransportMessage
remoteAddress, remoteAddress

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ClusterStateResponse
```
public ClusterStateResponse(StreamInput in)
                     throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - ClusterStateResponse
```
public ClusterStateResponse(ClusterName clusterName,
                            ClusterState clusterState,
                            boolean waitForTimedOut)
```
- Method Detail
  - getState
```
public ClusterState getState()
```
    The requested cluster state. Only the parts of the cluster state that were requested are included in the returned ClusterState instance.
  - getClusterName
```
public ClusterName 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
```
public void writeTo(StreamOutput out)
             throws java.io.IOException
```
    Description copied from interface: Writeable
    
    Write this into the StreamOutput.
    
    Throws:
    
    java.io.IOException
  - 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