Package org.opensearch.client.opensearch.nodes.info

Class NodeInfo

java.lang.Object

org.opensearch.client.opensearch.nodes.info.NodeInfo

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable

@JsonpDeserializable
public class NodeInfo
extends java.lang.Object
implements PlainJsonSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NodeInfo.Builder	Builder for NodeInfo.

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<NodeInfo>	_DESERIALIZER	Json deserializer for NodeInfo

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,NodeInfoAggregation>	aggregations()	API name: aggregations
java.util.Map<java.lang.String,java.lang.String>	attributes()	API name: attributes
java.lang.String	buildHash()	Required - Short hash of the last git commit in this release.
java.lang.String	buildType()	Required - API name: build_type
java.lang.String	host()	Required - The node's host name.
NodeInfoHttp	http()	API name: http
NodeInfoIngest	ingest()	API name: ingest
java.lang.String	ip()	Required - The node's IP address.
NodeJvmInfo	jvm()	API name: jvm
java.util.List<PluginStats>	modules()	API name: modules
java.lang.String	name()	Required - The node's name
NodeInfoNetwork	network()	API name: network
static NodeInfo	of(java.util.function.Function<NodeInfo.Builder,ObjectBuilder<NodeInfo>> fn)
NodeOperatingSystemInfo	os()	API name: os
java.util.List<PluginStats>	plugins()	API name: plugins
NodeProcessInfo	process()	API name: process
java.util.List<NodeRole>	roles()	Required - API name: roles
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
NodeInfoSettings	settings()	API name: settings
protected static void	setupNodeInfoDeserializer(ObjectDeserializer<NodeInfo.Builder> op)
java.util.Map<java.lang.String,NodeThreadPoolInfo>	threadPool()	API name: thread_pool
java.lang.Long	totalIndexingBuffer()	Total heap allowed to be used to hold recently indexed documents before they must be written to disk.
java.lang.String	totalIndexingBufferInBytes()	Same as total_indexing_buffer, but expressed in bytes.
NodeInfoTransport	transport()	API name: transport
java.lang.String	transportAddress()	Required - Host and port where transport HTTP connections are accepted.
java.lang.String	version()	Required - OpenSearch version running on this node.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<NodeInfo> _DESERIALIZER

Json deserializer for NodeInfo

Method Detail

of

public static NodeInfo of(java.util.function.Function<NodeInfo.Builder,ObjectBuilder<NodeInfo>> fn)

attributes

@Nullable
public final java.util.Map<java.lang.String,java.lang.String> attributes()

API name: attributes

buildHash

public final java.lang.String buildHash()

Required - Short hash of the last git commit in this release.

API name: build_hash

buildType

public final java.lang.String buildType()

Required - API name: build_type

host

@Nullable
public final java.lang.String host()

Required - The node's host name.

API name: host

http

@Nullable
public final NodeInfoHttp http()

API name: http

ip

@Nullable
public final java.lang.String ip()

Required - The node's IP address.

API name: ip

jvm

@Nullable
public final NodeJvmInfo jvm()

API name: jvm

name

public final java.lang.String name()

Required - The node's name

API name: name

network

@Nullable
public final NodeInfoNetwork network()

API name: network

os

@Nullable
public final NodeOperatingSystemInfo os()

API name: os

plugins

public final java.util.List<PluginStats> plugins()

API name: plugins

process

@Nullable
public final NodeProcessInfo process()

API name: process

roles

public final java.util.List<NodeRole> roles()

Required - API name: roles

settings

@Nullable
public final NodeInfoSettings settings()

API name: settings

threadPool

public final java.util.Map<java.lang.String,NodeThreadPoolInfo> threadPool()

API name: thread_pool

totalIndexingBuffer

@Nullable
public final java.lang.Long totalIndexingBuffer()

Total heap allowed to be used to hold recently indexed documents before they must be written to disk. This size is a shared pool across all shards on this node, and is controlled by Indexing Buffer settings.

API name: total_indexing_buffer

totalIndexingBufferInBytes

@Nullable
public final java.lang.String totalIndexingBufferInBytes()

Same as total_indexing_buffer, but expressed in bytes.

API name: total_indexing_buffer_in_bytes

transport

@Nullable
public final NodeInfoTransport transport()

API name: transport

transportAddress

@Nullable
public final java.lang.String transportAddress()

Required - Host and port where transport HTTP connections are accepted.

API name: transport_address

version

public final java.lang.String version()

Required - OpenSearch version running on this node.

API name: version

modules

public final java.util.List<PluginStats> modules()

API name: modules

ingest

@Nullable
public final NodeInfoIngest ingest()

API name: ingest

aggregations

public final java.util.Map<java.lang.String,NodeInfoAggregation> aggregations()

API name: aggregations

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
                      JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
                                 JsonpMapper mapper)

setupNodeInfoDeserializer

protected static void setupNodeInfoDeserializer(ObjectDeserializer<NodeInfo.Builder> op)