Package org.opensearch.client.opensearch.nodes.stats

Class JvmMemoryStats.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.nodes.stats.JvmMemoryStats.Builder

All Implemented Interfaces:

CopyableBuilder<JvmMemoryStats.Builder,JvmMemoryStats>, MutableBuilder<JvmMemoryStats.Builder,JvmMemoryStats>, ObjectBuilder<JvmMemoryStats>

Enclosing class:

JvmMemoryStats

public static class JvmMemoryStats.Builder
extends ObjectBuilderBase
implements CopyableBuilder<JvmMemoryStats.Builder,JvmMemoryStats>

Builder for JvmMemoryStats.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
JvmMemoryStats	build()	Builds a JvmMemoryStats.
JvmMemoryStats.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final JvmMemoryStats.Builder	heapCommitted(String value)	Amount of memory available for use by the heap.
final JvmMemoryStats.Builder	heapCommittedInBytes(Long value)	Amount of memory, in bytes, available for use by the heap.
final JvmMemoryStats.Builder	heapMax(String value)	Maximum amount of memory available for use by the heap.
final JvmMemoryStats.Builder	heapMaxInBytes(Long value)	Maximum amount of memory, in bytes, available for use by the heap.
final JvmMemoryStats.Builder	heapUsed(String value)	Memory currently in use by the heap.
final JvmMemoryStats.Builder	heapUsedInBytes(Long value)	Memory, in bytes, currently in use by the heap.
final JvmMemoryStats.Builder	heapUsedPercent(Double value)	Percentage of memory currently in use by the heap.
final JvmMemoryStats.Builder	nonHeapCommitted(String value)	Amount of non-heap memory available.
final JvmMemoryStats.Builder	nonHeapCommittedInBytes(Long value)	Amount of non-heap memory available, in bytes.
final JvmMemoryStats.Builder	nonHeapUsed(String value)	Non-heap memory used.
final JvmMemoryStats.Builder	nonHeapUsedInBytes(Long value)	Non-heap memory used, in bytes.
final JvmMemoryStats.Builder	pools(String key, Function<Pool.Builder,ObjectBuilder<Pool>> fn)	Contains statistics about heap memory usage for the node.
final JvmMemoryStats.Builder	pools(String key, Pool value)	Contains statistics about heap memory usage for the node.
final JvmMemoryStats.Builder	pools(Map<String,Pool> map)	Contains statistics about heap memory usage for the node.

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

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.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public JvmMemoryStats.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<JvmMemoryStats.Builder,JvmMemoryStats>

Returns:

a new builder instance.

heapCommitted

@Nonnull
public final JvmMemoryStats.Builder heapCommitted(@Nullable
 String value)

Amount of memory available for use by the heap.

API name: heap_committed

heapCommittedInBytes

@Nonnull
public final JvmMemoryStats.Builder heapCommittedInBytes(@Nullable
 Long value)

Amount of memory, in bytes, available for use by the heap.

API name: heap_committed_in_bytes

heapMax

@Nonnull
public final JvmMemoryStats.Builder heapMax(@Nullable
 String value)

Maximum amount of memory available for use by the heap.

API name: heap_max

heapMaxInBytes

@Nonnull
public final JvmMemoryStats.Builder heapMaxInBytes(@Nullable
 Long value)

Maximum amount of memory, in bytes, available for use by the heap.

API name: heap_max_in_bytes

heapUsed

@Nonnull
public final JvmMemoryStats.Builder heapUsed(@Nullable
 String value)

Memory currently in use by the heap.

API name: heap_used

heapUsedInBytes

@Nonnull
public final JvmMemoryStats.Builder heapUsedInBytes(@Nullable
 Long value)

Memory, in bytes, currently in use by the heap.

API name: heap_used_in_bytes

heapUsedPercent

@Nonnull
public final JvmMemoryStats.Builder heapUsedPercent(@Nullable
 Double value)

Percentage of memory currently in use by the heap.

API name: heap_used_percent

nonHeapCommitted

@Nonnull
public final JvmMemoryStats.Builder nonHeapCommitted(@Nullable
 String value)

Amount of non-heap memory available.

API name: non_heap_committed

nonHeapCommittedInBytes

@Nonnull
public final JvmMemoryStats.Builder nonHeapCommittedInBytes(@Nullable
 Long value)

Amount of non-heap memory available, in bytes.

API name: non_heap_committed_in_bytes

nonHeapUsed

@Nonnull
public final JvmMemoryStats.Builder nonHeapUsed(@Nullable
 String value)

Non-heap memory used.

API name: non_heap_used

nonHeapUsedInBytes

@Nonnull
public final JvmMemoryStats.Builder nonHeapUsedInBytes(@Nullable
 Long value)

Non-heap memory used, in bytes.

API name: non_heap_used_in_bytes

pools

@Nonnull
public final JvmMemoryStats.Builder pools(Map<String,Pool> map)

Contains statistics about heap memory usage for the node.

API name: pools

Adds all elements of map to pools.

pools

@Nonnull
public final JvmMemoryStats.Builder pools(String key,
 Pool value)

Contains statistics about heap memory usage for the node.

API name: pools

Adds an entry to pools.

pools

@Nonnull
public final JvmMemoryStats.Builder pools(String key,
 Function<Pool.Builder,ObjectBuilder<Pool>> fn)

Contains statistics about heap memory usage for the node.

API name: pools

Adds a value to pools using a builder lambda.

build

@Nonnull
public JvmMemoryStats build()

Builds a JvmMemoryStats.

Specified by:

build in interface ObjectBuilder<JvmMemoryStats>

Throws:

NullPointerException - if some of the required fields are null.