Package org.elasticsearch.action.admin.cluster.state

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:

Streamable, 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()
ClusterStateResponse(ClusterName clusterName, ClusterState clusterState, long sizeInBytes, boolean waitForTimedOut)

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.
ByteSizeValue	getTotalCompressedSize()	Deprecated.
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	readFrom(StreamInput in)	Set this object's fields from a StreamInput.
void	writeTo(StreamOutput out)	Write this object's fields to a 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()

ClusterStateResponse

public ClusterStateResponse(ClusterName clusterName,
                            ClusterState clusterState,
                            long sizeInBytes,
                            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.

getTotalCompressedSize

@Deprecated
public ByteSizeValue getTotalCompressedSize()

Deprecated.

The total compressed size of the full cluster state, not just the parts returned by getState(). The total compressed size is the size of the cluster state as it would be transmitted over the network during intra-node communication.

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.

readFrom

public void readFrom(StreamInput in)
              throws java.io.IOException

Description copied from interface: Streamable

Set this object's fields from a StreamInput.

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionResponse

Throws:

java.io.IOException

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Streamable

Write this object's fields to a StreamOutput.

Specified by:

writeTo in interface Streamable

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ActionResponse

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