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

Class NodeOperatingSystemInfo

java.lang.Object

org.opensearch.client.opensearch.nodes.info.NodeOperatingSystemInfo

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class NodeOperatingSystemInfo
extends java.lang.Object
implements JsonpSerializable

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
java.lang.Integer	allocatedProcessors()	The number of processors actually used to calculate thread pool size.
java.lang.String	arch()	Required - Name of the JVM architecture (ex: amd64, x86)
int	availableProcessors()	Required - Number of processors available to the Java virtual machine
NodeInfoOSCPU	cpu()	API name: cpu
NodeInfoMemory	mem()	API name: mem
java.lang.String	name()	Required - Name of the operating system (ex: Linux, Windows, Mac OS X)
static NodeOperatingSystemInfo	of(java.util.function.Function<NodeOperatingSystemInfo.Builder,ObjectBuilder<NodeOperatingSystemInfo>> fn)
java.lang.String	prettyName()	Required - API name: pretty_name
int	refreshIntervalInMillis()	Required - Refresh interval for the OS statistics
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupNodeOperatingSystemInfoDeserializer(ObjectDeserializer<NodeOperatingSystemInfo.Builder> op)
NodeInfoMemory	swap()	API name: swap
java.lang.String	version()	Required - Version of the operating system

Methods inherited from class java.lang.Object

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

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<NodeOperatingSystemInfo> _DESERIALIZER

Json deserializer for NodeOperatingSystemInfo

Method Detail

of

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

arch

public final java.lang.String arch()

Required - Name of the JVM architecture (ex: amd64, x86)

API name: arch

availableProcessors

public final int availableProcessors()

Required - Number of processors available to the Java virtual machine

API name: available_processors

allocatedProcessors

@Nullable
public final java.lang.Integer allocatedProcessors()

The number of processors actually used to calculate thread pool size. This number can be set with the node.processors setting of a node and defaults to the number of processors reported by the OS.

API name: allocated_processors

name

public final java.lang.String name()

Required - Name of the operating system (ex: Linux, Windows, Mac OS X)

API name: name

prettyName

public final java.lang.String prettyName()

Required - API name: pretty_name

refreshIntervalInMillis

public final int refreshIntervalInMillis()

Required - Refresh interval for the OS statistics

API name: refresh_interval_in_millis

version

public final java.lang.String version()

Required - Version of the operating system

API name: version

cpu

@Nullable
public final NodeInfoOSCPU cpu()

API name: cpu

mem

@Nullable
public final NodeInfoMemory mem()

API name: mem

swap

@Nullable
public final NodeInfoMemory swap()

API name: swap

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)

setupNodeOperatingSystemInfoDeserializer

protected static void setupNodeOperatingSystemInfoDeserializer(ObjectDeserializer<NodeOperatingSystemInfo.Builder> op)