Module org.elasticsearch.server

Package org.elasticsearch.action.support.nodes

Class BaseNodesResponse<TNodeResponse extends BaseNodeResponse>

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.support.nodes.BaseNodesResponse<TNodeResponse>

All Implemented Interfaces:

Writeable, RefCounted

Direct Known Subclasses:

BaseNodesXContentResponse, ClusterStatsResponse, FindDanglingIndexResponse, HealthApiStatsAction.Response, ListDanglingIndicesResponse, NodesHotThreadsResponse, NodesInfoResponse, NodesReloadSecureSettingsResponse, NodesUsageResponse, PrevalidateShardPathResponse, TransportNodesListGatewayStartedShards.NodesGatewayStartedShards, TransportNodesListShardStoreMetadata.NodesStoreFilesMetadata, TransportNodesSnapshotsStatus.NodesSnapshotStatus

public abstract class BaseNodesResponse<TNodeResponse extends BaseNodeResponse>
extends ActionResponse

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.action.ActionResponse

ActionResponse.Empty

Nested 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

Constructors

Modifier	Constructor	Description
protected	BaseNodesResponse(ClusterName clusterName, List<TNodeResponse> nodes, List<FailedNodeException> failures)
protected	BaseNodesResponse(StreamInput in)

Method Summary

Modifier and Type	Method	Description
List<FailedNodeException>	failures()	Get the failed node exceptions.
ClusterName	getClusterName()	Get the ClusterName associated with all of the nodes.
List<TNodeResponse>	getNodes()	Get the successful node responses.
Map<String,TNodeResponse>	getNodesMap()	Lazily build and get a map of Node ID to node response.
boolean	hasFailures()	Determine if there are any node failures in failures.
protected abstract List<TNodeResponse>	readNodesFrom(StreamInput in)	Read the nodes from the stream.
protected abstract void	writeNodesTo(StreamOutput out, List<TNodeResponse> nodes)	Write the nodes to the stream.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.core.RefCounted

mustIncRef

Constructor Details

BaseNodesResponse

protected BaseNodesResponse(StreamInput in)
                     throws IOException

Throws:

IOException

BaseNodesResponse

protected BaseNodesResponse(ClusterName clusterName,
 List<TNodeResponse> nodes,
 List<FailedNodeException> failures)

Method Details

getClusterName

public ClusterName getClusterName()

Get the ClusterName associated with all of the nodes.

Returns:

Never null.

failures

public List<FailedNodeException> failures()

Get the failed node exceptions.

Returns:

Never null. Can be empty.

hasFailures

public boolean hasFailures()

Determine if there are any node failures in failures.

Returns:

true if failures contains at least 1 FailedNodeException.

getNodes

public List<TNodeResponse> getNodes()

Get the successful node responses.

Returns:

Never null. Can be empty.

See Also:

• hasFailures()

getNodesMap

public Map<String,TNodeResponse> getNodesMap()

Lazily build and get a map of Node ID to node response.

Returns:

Never null. Can be empty.

See Also:

• getNodes()

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Throws:

IOException

readNodesFrom

protected abstract List<TNodeResponse> readNodesFrom(StreamInput in)
                                              throws IOException

Read the nodes from the stream.

Returns:

Never null.

Throws:

IOException

writeNodesTo

protected abstract void writeNodesTo(StreamOutput out,
 List<TNodeResponse> nodes)
                              throws IOException

Write the nodes to the stream.

Throws:

IOException