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

Class ClusterOperatingSystem.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.cluster.stats.ClusterOperatingSystem.Builder

All Implemented Interfaces:

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

Enclosing class:

ClusterOperatingSystem

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

Builder for ClusterOperatingSystem.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final ClusterOperatingSystem.Builder	allocatedProcessors(int value)	Required - Number of processors used to calculate thread pool size across all selected nodes.
final ClusterOperatingSystem.Builder	architectures(Function<ClusterOperatingSystemArchitecture.Builder,ObjectBuilder<ClusterOperatingSystemArchitecture>> fn)	Contains statistics about processor architectures (for example, x86_64 or aarch64) used by selected nodes.
final ClusterOperatingSystem.Builder	architectures(List<ClusterOperatingSystemArchitecture> list)	Contains statistics about processor architectures (for example, x86_64 or aarch64) used by selected nodes.
final ClusterOperatingSystem.Builder	architectures(ClusterOperatingSystemArchitecture value, ClusterOperatingSystemArchitecture... values)	Contains statistics about processor architectures (for example, x86_64 or aarch64) used by selected nodes.
final ClusterOperatingSystem.Builder	availableProcessors(int value)	Required - Number of processors available to JVM across all selected nodes.
ClusterOperatingSystem	build()	Builds a ClusterOperatingSystem.
ClusterOperatingSystem.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ClusterOperatingSystem.Builder	mem(Function<OperatingSystemMemoryInfo.Builder,ObjectBuilder<OperatingSystemMemoryInfo>> fn)	Required - API name: mem
final ClusterOperatingSystem.Builder	mem(OperatingSystemMemoryInfo value)	Required - API name: mem
final ClusterOperatingSystem.Builder	names(Function<ClusterOperatingSystemName.Builder,ObjectBuilder<ClusterOperatingSystemName>> fn)	Required - Contains statistics about operating systems used by selected nodes.
final ClusterOperatingSystem.Builder	names(List<ClusterOperatingSystemName> list)	Required - Contains statistics about operating systems used by selected nodes.
final ClusterOperatingSystem.Builder	names(ClusterOperatingSystemName value, ClusterOperatingSystemName... values)	Required - Contains statistics about operating systems used by selected nodes.
final ClusterOperatingSystem.Builder	prettyNames(Function<ClusterOperatingSystemPrettyName.Builder,ObjectBuilder<ClusterOperatingSystemPrettyName>> fn)	Required - Contains statistics about operating systems used by selected nodes.
final ClusterOperatingSystem.Builder	prettyNames(List<ClusterOperatingSystemPrettyName> list)	Required - Contains statistics about operating systems used by selected nodes.
final ClusterOperatingSystem.Builder	prettyNames(ClusterOperatingSystemPrettyName value, ClusterOperatingSystemPrettyName... values)	Required - Contains statistics about operating systems used by 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 ClusterOperatingSystem.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<ClusterOperatingSystem.Builder,ClusterOperatingSystem>

Returns:

a new builder instance.

allocatedProcessors

@Nonnull
public final ClusterOperatingSystem.Builder allocatedProcessors(int value)

Required - Number of processors used to calculate thread pool size across all selected nodes. This number can be set with the processors setting of a node and defaults to the number of processors reported by the operating system. In both cases, this number will never be larger than 32.

API name: allocated_processors

architectures

@Nonnull
public final ClusterOperatingSystem.Builder architectures(List<ClusterOperatingSystemArchitecture> list)

Contains statistics about processor architectures (for example, x86_64 or aarch64) used by selected nodes.

API name: architectures

Adds all elements of list to architectures.

architectures

@Nonnull
public final ClusterOperatingSystem.Builder architectures(ClusterOperatingSystemArchitecture value,
 ClusterOperatingSystemArchitecture... values)

Contains statistics about processor architectures (for example, x86_64 or aarch64) used by selected nodes.

API name: architectures

Adds one or more values to architectures.

architectures

@Nonnull
public final ClusterOperatingSystem.Builder architectures(Function<ClusterOperatingSystemArchitecture.Builder,ObjectBuilder<ClusterOperatingSystemArchitecture>> fn)

Contains statistics about processor architectures (for example, x86_64 or aarch64) used by selected nodes.

API name: architectures

Adds a value to architectures using a builder lambda.

availableProcessors

@Nonnull
public final ClusterOperatingSystem.Builder availableProcessors(int value)

Required - Number of processors available to JVM across all selected nodes.

API name: available_processors

mem

@Nonnull
public final ClusterOperatingSystem.Builder mem(OperatingSystemMemoryInfo value)

Required - API name: mem

mem

@Nonnull
public final ClusterOperatingSystem.Builder mem(Function<OperatingSystemMemoryInfo.Builder,ObjectBuilder<OperatingSystemMemoryInfo>> fn)

Required - API name: mem

names

@Nonnull
public final ClusterOperatingSystem.Builder names(List<ClusterOperatingSystemName> list)

Required - Contains statistics about operating systems used by selected nodes.

API name: names

Adds all elements of list to names.

names

@Nonnull
public final ClusterOperatingSystem.Builder names(ClusterOperatingSystemName value,
 ClusterOperatingSystemName... values)

Required - Contains statistics about operating systems used by selected nodes.

API name: names

Adds one or more values to names.

names

@Nonnull
public final ClusterOperatingSystem.Builder names(Function<ClusterOperatingSystemName.Builder,ObjectBuilder<ClusterOperatingSystemName>> fn)

Required - Contains statistics about operating systems used by selected nodes.

API name: names

Adds a value to names using a builder lambda.

prettyNames

@Nonnull
public final ClusterOperatingSystem.Builder prettyNames(List<ClusterOperatingSystemPrettyName> list)

Required - Contains statistics about operating systems used by selected nodes.

API name: pretty_names

Adds all elements of list to prettyNames.

prettyNames

@Nonnull
public final ClusterOperatingSystem.Builder prettyNames(ClusterOperatingSystemPrettyName value,
 ClusterOperatingSystemPrettyName... values)

Required - Contains statistics about operating systems used by selected nodes.

API name: pretty_names

Adds one or more values to prettyNames.

prettyNames

@Nonnull
public final ClusterOperatingSystem.Builder prettyNames(Function<ClusterOperatingSystemPrettyName.Builder,ObjectBuilder<ClusterOperatingSystemPrettyName>> fn)

Required - Contains statistics about operating systems used by selected nodes.

API name: pretty_names

Adds a value to prettyNames using a builder lambda.

build

@Nonnull
public ClusterOperatingSystem build()

Builds a ClusterOperatingSystem.

Specified by:

build in interface ObjectBuilder<ClusterOperatingSystem>

Throws:

NullPointerException - if some of the required fields are null.