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 -
Method Summary
Modifier and TypeMethodDescriptionallocatedProcessors(int value) Required - Number of processors used to calculate thread pool size across all selected nodes.architectures(Function<ClusterOperatingSystemArchitecture.Builder, ObjectBuilder<ClusterOperatingSystemArchitecture>> fn) Contains statistics about processor architectures (for example, x86_64 or aarch64) used by selected nodes.Contains statistics about processor architectures (for example, x86_64 or aarch64) used by selected nodes.architectures(ClusterOperatingSystemArchitecture value, ClusterOperatingSystemArchitecture... values) Contains statistics about processor architectures (for example, x86_64 or aarch64) used by selected nodes.availableProcessors(int value) Required - Number of processors available to JVM across all selected nodes.build()Builds aClusterOperatingSystem.copy()Create a new builderCopyableBuilderthat is a copy of this one.Required - API name:memmem(OperatingSystemMemoryInfo value) Required - API name:memRequired - Contains statistics about operating systems used by selected nodes.names(List<ClusterOperatingSystemName> list) Required - Contains statistics about operating systems used by selected nodes.names(ClusterOperatingSystemName value, ClusterOperatingSystemName... values) Required - Contains statistics about operating systems used by selected nodes.prettyNames(Function<ClusterOperatingSystemPrettyName.Builder, ObjectBuilder<ClusterOperatingSystemPrettyName>> fn) Required - Contains statistics about operating systems used by selected nodes.Required - Contains statistics about operating systems used by selected nodes.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, _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<ClusterOperatingSystem.Builder,ClusterOperatingSystem> - Returns:
- a new builder instance.
-
allocatedProcessors
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:
architecturesAdds all elements of
listtoarchitectures. -
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:
architecturesAdds 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:
architecturesAdds a value to
architecturesusing a builder lambda. -
availableProcessors
Required - Number of processors available to JVM across all selected nodes.API name:
available_processors -
mem
Required - API name:mem -
mem
@Nonnull public final ClusterOperatingSystem.Builder mem(Function<OperatingSystemMemoryInfo.Builder, ObjectBuilder<OperatingSystemMemoryInfo>> fn) Required - API name:mem -
names
Required - Contains statistics about operating systems used by selected nodes.API name:
namesAdds all elements of
listtonames. -
names
@Nonnull public final ClusterOperatingSystem.Builder names(ClusterOperatingSystemName value, ClusterOperatingSystemName... values) Required - Contains statistics about operating systems used by selected nodes.API name:
namesAdds 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:
namesAdds a value to
namesusing 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_namesAdds all elements of
listtoprettyNames. -
prettyNames
@Nonnull public final ClusterOperatingSystem.Builder prettyNames(ClusterOperatingSystemPrettyName value, ClusterOperatingSystemPrettyName... values) Required - Contains statistics about operating systems used by selected nodes.API name:
pretty_namesAdds 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_namesAdds a value to
prettyNamesusing a builder lambda. -
build
Builds aClusterOperatingSystem.- Specified by:
buildin interfaceObjectBuilder<ClusterOperatingSystem>- Throws:
NullPointerException- if some of the required fields are null.
-