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

Class NodeOperatingSystemInfo

java.lang.Object

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

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<NodeOperatingSystemInfo.Builder,NodeOperatingSystemInfo>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class NodeOperatingSystemInfo
extends Object
implements PlainJsonSerializable, ToCopyableBuilder<NodeOperatingSystemInfo.Builder,NodeOperatingSystemInfo>

Provides operating system information for the node.

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 final JsonpDeserializer<NodeOperatingSystemInfo>	_DESERIALIZER	Json deserializer for NodeOperatingSystemInfo

Method Summary

Modifier and Type	Method	Description
final Integer	allocatedProcessors()	The number of processors actually used to calculate thread pool size.
final String	arch()	Name of the JVM architecture, for example amd64 or x86.
final int	availableProcessors()	Required - The number of processors available to the Java virtual machine.
static NodeOperatingSystemInfo.Builder	builder()
final NodeInfoOSCPU	cpu()	API name: cpu
boolean	equals(Object o)
int	hashCode()
final NodeInfoMemory	mem()	API name: mem
final String	name()	API name: name
static NodeOperatingSystemInfo	of(Function<NodeOperatingSystemInfo.Builder,ObjectBuilder<NodeOperatingSystemInfo>> fn)
final String	prettyName()	API name: pretty_name
final Time	refreshInterval()	API name: refresh_interval
final long	refreshIntervalInMillis()	Required - API name: refresh_interval_in_millis
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)
final NodeInfoMemory	swap()	API name: swap
NodeOperatingSystemInfo.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final String	version()	API name: version

Methods inherited from class java.lang.Object

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

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

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<NodeOperatingSystemInfo> _DESERIALIZER

Json deserializer for NodeOperatingSystemInfo

Method Details

of

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

allocatedProcessors

@Nullable
public final 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

arch

@Nullable
public final String arch()

Name of the JVM architecture, for example amd64 or x86.

API name: arch

availableProcessors

public final int availableProcessors()

Required - The number of processors available to the Java virtual machine.

API name: available_processors

cpu

@Nullable
public final NodeInfoOSCPU cpu()

API name: cpu

mem

@Nullable
public final NodeInfoMemory mem()

API name: mem

name

@Nullable
public final String name()

API name: name

prettyName

@Nullable
public final String prettyName()

API name: pretty_name

refreshInterval

@Nullable
public final Time refreshInterval()

API name: refresh_interval

refreshIntervalInMillis

public final long refreshIntervalInMillis()

Required - API name: refresh_interval_in_millis

swap

@Nullable
public final NodeInfoMemory swap()

API name: swap

version

@Nullable
public final String version()

API name: version

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)

toBuilder

@Nonnull
public NodeOperatingSystemInfo.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<NodeOperatingSystemInfo.Builder,NodeOperatingSystemInfo>

Returns:

a new builder instance.

builder

@Nonnull
public static NodeOperatingSystemInfo.Builder builder()

setupNodeOperatingSystemInfoDeserializer

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object