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

Class ClusterJvmMemory

java.lang.Object

org.opensearch.client.opensearch.cluster.stats.ClusterJvmMemory

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static ClusterJvmMemory.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final String	heapMax()	Maximum amount of memory available for use by the heap across all selected nodes.
final long	heapMaxInBytes()	Required - Maximum amount of memory, in bytes, available for use by the heap across all selected nodes.
final String	heapUsed()	Memory currently in use by the heap across all selected nodes.
final long	heapUsedInBytes()	Required - Memory, in bytes, currently in use by the heap across all selected nodes.
static ClusterJvmMemory	of(Function<ClusterJvmMemory.Builder,ObjectBuilder<ClusterJvmMemory>> fn)
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	setupClusterJvmMemoryDeserializer(ObjectDeserializer<ClusterJvmMemory.Builder> op)
ClusterJvmMemory.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<ClusterJvmMemory> _DESERIALIZER

Json deserializer for ClusterJvmMemory

Method Details

of

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

heapMax

@Nullable
public final String heapMax()

Maximum amount of memory available for use by the heap across all selected nodes.

API name: heap_max

heapMaxInBytes

public final long heapMaxInBytes()

Required - Maximum amount of memory, in bytes, available for use by the heap across all selected nodes.

API name: heap_max_in_bytes

heapUsed

@Nullable
public final String heapUsed()

Memory currently in use by the heap across all selected nodes.

API name: heap_used

heapUsedInBytes

public final long heapUsedInBytes()

Required - Memory, in bytes, currently in use by the heap across all selected nodes.

API name: heap_used_in_bytes

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

Returns:

a new builder instance.

builder

@Nonnull
public static ClusterJvmMemory.Builder builder()

setupClusterJvmMemoryDeserializer

protected static void setupClusterJvmMemoryDeserializer(ObjectDeserializer<ClusterJvmMemory.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object