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

Class ExtendedMemoryStats.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.nodes.stats.MemoryStatsBase.AbstractBuilder<ExtendedMemoryStats.Builder>

org.opensearch.client.opensearch.nodes.stats.ExtendedMemoryStats.Builder

All Implemented Interfaces:

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

Enclosing class:

ExtendedMemoryStats

public static class ExtendedMemoryStats.Builder
extends MemoryStatsBase.AbstractBuilder<ExtendedMemoryStats.Builder>
implements CopyableBuilder<ExtendedMemoryStats.Builder,ExtendedMemoryStats>

Builder for ExtendedMemoryStats.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ExtendedMemoryStats	build()	Builds a ExtendedMemoryStats.
ExtendedMemoryStats.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ExtendedMemoryStats.Builder	freePercent(Double value)	Percentage of free memory.
protected ExtendedMemoryStats.Builder	self()
final ExtendedMemoryStats.Builder	usedPercent(Double value)	Percentage of used memory.

Methods inherited from class org.opensearch.client.opensearch.nodes.stats.MemoryStatsBase.AbstractBuilder

free, freeInBytes, total, totalInBytes, used, usedInBytes

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

Returns:

a new builder instance.

self

@Nonnull
protected ExtendedMemoryStats.Builder self()

Specified by:

self in class MemoryStatsBase.AbstractBuilder<ExtendedMemoryStats.Builder>

freePercent

@Nonnull
public final ExtendedMemoryStats.Builder freePercent(@Nullable
 Double value)

Percentage of free memory.

API name: free_percent

usedPercent

@Nonnull
public final ExtendedMemoryStats.Builder usedPercent(@Nullable
 Double value)

Percentage of used memory.

API name: used_percent

build

@Nonnull
public ExtendedMemoryStats build()

Builds a ExtendedMemoryStats.

Specified by:

build in interface ObjectBuilder<ExtendedMemoryStats>

Throws:

NullPointerException - if some of the required fields are null.