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

Class ClusterJvmMemory.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

All Implemented Interfaces:

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

Enclosing class:

ClusterJvmMemory

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

Builder for ClusterJvmMemory.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ClusterJvmMemory	build()	Builds a ClusterJvmMemory.
ClusterJvmMemory.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ClusterJvmMemory.Builder	heapMax(String value)	Maximum amount of memory available for use by the heap across all selected nodes.
final ClusterJvmMemory.Builder	heapMaxInBytes(long value)	Required - Maximum amount of memory, in bytes, available for use by the heap across all selected nodes.
final ClusterJvmMemory.Builder	heapUsed(String value)	Memory currently in use by the heap across all selected nodes.
final ClusterJvmMemory.Builder	heapUsedInBytes(long value)	Required - Memory, in bytes, currently in use by the heap across all selected nodes.

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

Returns:

a new builder instance.

heapMax

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

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

API name: heap_max

heapMaxInBytes

@Nonnull
public final ClusterJvmMemory.Builder heapMaxInBytes(long value)

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

API name: heap_max_in_bytes

heapUsed

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

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

API name: heap_used

heapUsedInBytes

@Nonnull
public final ClusterJvmMemory.Builder heapUsedInBytes(long value)

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

API name: heap_used_in_bytes

build

@Nonnull
public ClusterJvmMemory build()

Builds a ClusterJvmMemory.

Specified by:

build in interface ObjectBuilder<ClusterJvmMemory>

Throws:

NullPointerException - if some of the required fields are null.