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

Class OperatingSystemMemoryInfo.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.cluster.stats.OperatingSystemMemoryInfo.Builder

All Implemented Interfaces:

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

Enclosing class:

OperatingSystemMemoryInfo

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

Builder for OperatingSystemMemoryInfo.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final OperatingSystemMemoryInfo.Builder	adjustedTotalInBytes(Long value)	Total amount, in bytes, of memory across all selected nodes, but using the value specified using the es.total_memory_bytes system property instead of measured total memory for those nodes where that system property was set.
OperatingSystemMemoryInfo	build()	Builds a OperatingSystemMemoryInfo.
OperatingSystemMemoryInfo.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final OperatingSystemMemoryInfo.Builder	free(String value)	Amount, in bytes, of free physical memory across all selected nodes.
final OperatingSystemMemoryInfo.Builder	freeInBytes(long value)	Required - Amount, in bytes, of free physical memory across all selected nodes.
final OperatingSystemMemoryInfo.Builder	freePercent(double value)	Required - Percentage of free physical memory across all selected nodes.
final OperatingSystemMemoryInfo.Builder	total(String value)	Total amount of physical memory across all selected nodes.
final OperatingSystemMemoryInfo.Builder	totalInBytes(long value)	Required - Total amount, in bytes, of physical memory across all selected nodes.
final OperatingSystemMemoryInfo.Builder	used(String value)	Amount of physical memory in use across all selected nodes.
final OperatingSystemMemoryInfo.Builder	usedInBytes(long value)	Required - Amount, in bytes, of physical memory in use across all selected nodes.
final OperatingSystemMemoryInfo.Builder	usedPercent(double value)	Required - Percentage of physical memory in use 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 OperatingSystemMemoryInfo.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<OperatingSystemMemoryInfo.Builder,OperatingSystemMemoryInfo>

Returns:

a new builder instance.

adjustedTotalInBytes

@Nonnull
public final OperatingSystemMemoryInfo.Builder adjustedTotalInBytes(@Nullable
 Long value)

Total amount, in bytes, of memory across all selected nodes, but using the value specified using the es.total_memory_bytes system property instead of measured total memory for those nodes where that system property was set.

API name: adjusted_total_in_bytes

free

@Nonnull
public final OperatingSystemMemoryInfo.Builder free(@Nullable
 String value)

Amount, in bytes, of free physical memory across all selected nodes.

API name: free

freeInBytes

@Nonnull
public final OperatingSystemMemoryInfo.Builder freeInBytes(long value)

Required - Amount, in bytes, of free physical memory across all selected nodes.

API name: free_in_bytes

freePercent

@Nonnull
public final OperatingSystemMemoryInfo.Builder freePercent(double value)

Required - Percentage of free physical memory across all selected nodes.

API name: free_percent

total

@Nonnull
public final OperatingSystemMemoryInfo.Builder total(@Nullable
 String value)

Total amount of physical memory across all selected nodes.

API name: total

totalInBytes

@Nonnull
public final OperatingSystemMemoryInfo.Builder totalInBytes(long value)

Required - Total amount, in bytes, of physical memory across all selected nodes.

API name: total_in_bytes

used

@Nonnull
public final OperatingSystemMemoryInfo.Builder used(@Nullable
 String value)

Amount of physical memory in use across all selected nodes.

API name: used

usedInBytes

@Nonnull
public final OperatingSystemMemoryInfo.Builder usedInBytes(long value)

Required - Amount, in bytes, of physical memory in use across all selected nodes.

API name: used_in_bytes

usedPercent

@Nonnull
public final OperatingSystemMemoryInfo.Builder usedPercent(double value)

Required - Percentage of physical memory in use across all selected nodes.

API name: used_percent

build

@Nonnull
public OperatingSystemMemoryInfo build()

Builds a OperatingSystemMemoryInfo.

Specified by:

build in interface ObjectBuilder<OperatingSystemMemoryInfo>

Throws:

NullPointerException - if some of the required fields are null.