Package org.elasticsearch.action.admin.cluster.node.info

Class NodeInfo

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.support.nodes.BaseNodeResponse

org.elasticsearch.action.admin.cluster.node.info.NodeInfo

All Implemented Interfaces:

Writeable, org.elasticsearch.common.util.concurrent.RefCounted

public class NodeInfo
extends BaseNodeResponse

Node information (static, does not change over time).

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
NodeInfo(StreamInput in)
NodeInfo(Version version, Build build, DiscoveryNode node, Settings settings, OsInfo os, ProcessInfo process, JvmInfo jvm, ThreadPoolInfo threadPool, TransportInfo transport, HttpInfo http, PluginsAndModules plugins, IngestInfo ingest, AggregationInfo aggsInfo, ByteSizeValue totalIndexingBuffer)

Method Summary

Modifier and Type	Method	Description
Build	getBuild()	The build version of the node.
java.lang.String	getHostname()	System's hostname.
<T extends ReportingService.Info> T	getInfo(java.lang.Class<T> clazz)	Get a particular info object, e.g.
Settings	getSettings()	The settings of the node.
ByteSizeValue	getTotalIndexingBuffer()
Version	getVersion()	The current ES version
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.action.support.nodes.BaseNodeResponse

getNode

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, incRef, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.Object

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

Constructor Details

NodeInfo

public NodeInfo(StreamInput in)
         throws java.io.IOException

Throws:

java.io.IOException

NodeInfo

public NodeInfo(Version version,
Build build,
DiscoveryNode node,
@Nullable
Settings settings,
@Nullable
OsInfo os,
@Nullable
ProcessInfo process,
@Nullable
JvmInfo jvm,
@Nullable
ThreadPoolInfo threadPool,
@Nullable
TransportInfo transport,
@Nullable
HttpInfo http,
@Nullable
PluginsAndModules plugins,
@Nullable
IngestInfo ingest,
@Nullable
AggregationInfo aggsInfo,
@Nullable
ByteSizeValue totalIndexingBuffer)

Method Details

getHostname

@Nullable
public java.lang.String getHostname()

System's hostname. null in case of UnknownHostException

getVersion

public Version getVersion()

The current ES version

getBuild

public Build getBuild()

The build version of the node.

getSettings

@Nullable
public Settings getSettings()

The settings of the node.

getInfo

public <T extends ReportingService.Info> T getInfo(java.lang.Class<T> clazz)

Get a particular info object, e.g. JvmInfo or OsInfo. This generic method handles all casting in order to spare client classes the work of explicit casts. This NodeInfo class guarantees type safety for these stored info blocks.

Type Parameters:

T - Specific subtype of ReportingService.Info to retrieve.

Parameters:

clazz - Class for retrieval.

Returns:

An object of type T.

getTotalIndexingBuffer

@Nullable
public ByteSizeValue getTotalIndexingBuffer()

writeTo

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

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class BaseNodeResponse

Throws:

java.io.IOException