Package org.opensearch.client.opensearch.cluster.stats

Class ClusterOperatingSystem

java.lang.Object

org.opensearch.client.opensearch.cluster.stats.ClusterOperatingSystem

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final int	allocatedProcessors()	Required - Number of processors used to calculate thread pool size across all selected nodes.
final List<ClusterOperatingSystemArchitecture>	architectures()	Contains statistics about processor architectures (for example, x86_64 or aarch64) used by selected nodes.
final int	availableProcessors()	Required - Number of processors available to JVM across all selected nodes.
static ClusterOperatingSystem.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final OperatingSystemMemoryInfo	mem()	Required - API name: mem
final List<ClusterOperatingSystemName>	names()	Required - Contains statistics about operating systems used by selected nodes.
static ClusterOperatingSystem	of(Function<ClusterOperatingSystem.Builder,ObjectBuilder<ClusterOperatingSystem>> fn)
final List<ClusterOperatingSystemPrettyName>	prettyNames()	Required - Contains statistics about operating systems used by selected nodes.
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	setupClusterOperatingSystemDeserializer(ObjectDeserializer<ClusterOperatingSystem.Builder> op)
ClusterOperatingSystem.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

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<ClusterOperatingSystem> _DESERIALIZER

Json deserializer for ClusterOperatingSystem

Method Details

of

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

allocatedProcessors

public final int allocatedProcessors()

Required - Number of processors used to calculate thread pool size across all selected nodes. This number can be set with the processors setting of a node and defaults to the number of processors reported by the operating system. In both cases, this number will never be larger than 32.

API name: allocated_processors

architectures

@Nonnull
public final List<ClusterOperatingSystemArchitecture> architectures()

Contains statistics about processor architectures (for example, x86_64 or aarch64) used by selected nodes.

API name: architectures

availableProcessors

public final int availableProcessors()

Required - Number of processors available to JVM across all selected nodes.

API name: available_processors

mem

@Nonnull
public final OperatingSystemMemoryInfo mem()

Required - API name: mem

names

@Nonnull
public final List<ClusterOperatingSystemName> names()

Required - Contains statistics about operating systems used by selected nodes.

API name: names

prettyNames

@Nonnull
public final List<ClusterOperatingSystemPrettyName> prettyNames()

Required - Contains statistics about operating systems used by selected nodes.

API name: pretty_names

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 ClusterOperatingSystem.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<ClusterOperatingSystem.Builder,ClusterOperatingSystem>

Returns:

a new builder instance.

builder

@Nonnull
public static ClusterOperatingSystem.Builder builder()

setupClusterOperatingSystemDeserializer

protected static void setupClusterOperatingSystemDeserializer(ObjectDeserializer<ClusterOperatingSystem.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object