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

Class CgroupMemoryStats.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.nodes.stats.CgroupMemoryStats.Builder

All Implemented Interfaces:

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

Enclosing class:

CgroupMemoryStats

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

Builder for CgroupMemoryStats.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CgroupMemoryStats	build()	Builds a CgroupMemoryStats.
final CgroupMemoryStats.Builder	controlGroup(String value)	The memory control group to which the OpenSearch process belongs.
CgroupMemoryStats.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final CgroupMemoryStats.Builder	limitInBytes(String value)	The maximum amount of user memory (including file cache) allowed for all tasks in the same cgroup as the OpenSearch process.
final CgroupMemoryStats.Builder	usageInBytes(String value)	The total current memory usage by processes in the cgroup, in bytes, by all tasks in the same cgroup as the OpenSearch process.

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

Returns:

a new builder instance.

controlGroup

@Nonnull
public final CgroupMemoryStats.Builder controlGroup(@Nullable
 String value)

The memory control group to which the OpenSearch process belongs.

API name: control_group

limitInBytes

@Nonnull
public final CgroupMemoryStats.Builder limitInBytes(@Nullable
 String value)

The maximum amount of user memory (including file cache) allowed for all tasks in the same cgroup as the OpenSearch process. This value can be too big to store in a long, so is returned as a string so that the value returned can exactly match what the underlying operating system interface returns. Any value that is too large to parse into a long almost certainly means no limit has been set for the cgroup.

API name: limit_in_bytes

usageInBytes

@Nonnull
public final CgroupMemoryStats.Builder usageInBytes(@Nullable
 String value)

The total current memory usage by processes in the cgroup, in bytes, by all tasks in the same cgroup as the OpenSearch process. This value is stored as a string for consistency with limit_in_bytes.

API name: usage_in_bytes

build

@Nonnull
public CgroupMemoryStats build()

Builds a CgroupMemoryStats.

Specified by:

build in interface ObjectBuilder<CgroupMemoryStats>

Throws:

NullPointerException - if some of the required fields are null.