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 -
Method Summary
Modifier and TypeMethodDescriptionadjustedTotalInBytes(Long value) Total amount, in bytes, of memory across all selected nodes, but using the value specified using thees.total_memory_bytessystem property instead of measured total memory for those nodes where that system property was set.build()Builds aOperatingSystemMemoryInfo.copy()Create a new builderCopyableBuilderthat is a copy of this one.Amount, in bytes, of free physical memory across all selected nodes.freeInBytes(long value) Required - Amount, in bytes, of free physical memory across all selected nodes.freePercent(double value) Required - Percentage of free physical memory across all selected nodes.Total amount of physical memory across all selected nodes.totalInBytes(long value) Required - Total amount, in bytes, of physical memory across all selected nodes.Amount of physical memory in use across all selected nodes.usedInBytes(long value) Required - Amount, in bytes, of physical memory in use across all selected nodes.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, _mapPutAllMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.util.MutableBuilder
applyMutation
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
copy
Description copied from interface:CopyableBuilderCreate a new builderCopyableBuilderthat is a copy of this one.- Specified by:
copyin interfaceCopyableBuilder<OperatingSystemMemoryInfo.Builder,OperatingSystemMemoryInfo> - Returns:
- a new builder instance.
-
adjustedTotalInBytes
Total amount, in bytes, of memory across all selected nodes, but using the value specified using thees.total_memory_bytessystem property instead of measured total memory for those nodes where that system property was set.API name:
adjusted_total_in_bytes -
free
Amount, in bytes, of free physical memory across all selected nodes.API name:
free -
freeInBytes
Required - Amount, in bytes, of free physical memory across all selected nodes.API name:
free_in_bytes -
freePercent
Required - Percentage of free physical memory across all selected nodes.API name:
free_percent -
total
Total amount of physical memory across all selected nodes.API name:
total -
totalInBytes
Required - Total amount, in bytes, of physical memory across all selected nodes.API name:
total_in_bytes -
used
Amount of physical memory in use across all selected nodes.API name:
used -
usedInBytes
Required - Amount, in bytes, of physical memory in use across all selected nodes.API name:
used_in_bytes -
usedPercent
Required - Percentage of physical memory in use across all selected nodes.API name:
used_percent -
build
Builds aOperatingSystemMemoryInfo.- Specified by:
buildin interfaceObjectBuilder<OperatingSystemMemoryInfo>- Throws:
NullPointerException- if some of the required fields are null.
-