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

Class ClusterNodes.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.cluster.stats.ClusterNodes.Builder

All Implemented Interfaces:

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

Enclosing class:

ClusterNodes

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

Builder for ClusterNodes.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ClusterNodes	build()	Builds a ClusterNodes.
ClusterNodes.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ClusterNodes.Builder	count(Function<ClusterNodeCount.Builder,ObjectBuilder<ClusterNodeCount>> fn)	Contains counts for nodes selected by the request's node filters.
final ClusterNodes.Builder	count(ClusterNodeCount value)	Contains counts for nodes selected by the request's node filters.
final ClusterNodes.Builder	discoveryTypes(String key, Integer value)	Contains statistics about the discovery types used by selected nodes.
final ClusterNodes.Builder	discoveryTypes(Map<String,Integer> map)	Contains statistics about the discovery types used by selected nodes.
final ClusterNodes.Builder	fs(Function<ClusterFileSystem.Builder,ObjectBuilder<ClusterFileSystem>> fn)	Contains statistics about file stores by selected nodes.
final ClusterNodes.Builder	fs(ClusterFileSystem value)	Contains statistics about file stores by selected nodes.
final ClusterNodes.Builder	indexingPressure(Function<IndexingPressure.Builder,ObjectBuilder<IndexingPressure>> fn)	API name: indexing_pressure
final ClusterNodes.Builder	indexingPressure(IndexingPressure value)	API name: indexing_pressure
final ClusterNodes.Builder	ingest(Function<ClusterIngest.Builder,ObjectBuilder<ClusterIngest>> fn)	API name: ingest
final ClusterNodes.Builder	ingest(ClusterIngest value)	API name: ingest
final ClusterNodes.Builder	jvm(Function<ClusterJvm.Builder,ObjectBuilder<ClusterJvm>> fn)	Contains statistics about the Java Virtual Machines (JVMs) used by selected nodes.
final ClusterNodes.Builder	jvm(ClusterJvm value)	Contains statistics about the Java Virtual Machines (JVMs) used by selected nodes.
final ClusterNodes.Builder	networkTypes(Function<ClusterNetworkTypes.Builder,ObjectBuilder<ClusterNetworkTypes>> fn)	Contains statistics about the transport and HTTP networks used by selected nodes.
final ClusterNodes.Builder	networkTypes(ClusterNetworkTypes value)	Contains statistics about the transport and HTTP networks used by selected nodes.
final ClusterNodes.Builder	os(Function<ClusterOperatingSystem.Builder,ObjectBuilder<ClusterOperatingSystem>> fn)	Contains statistics about the operating systems used by selected nodes.
final ClusterNodes.Builder	os(ClusterOperatingSystem value)	Contains statistics about the operating systems used by selected nodes.
final ClusterNodes.Builder	packagingTypes(Function<NodePackagingType.Builder,ObjectBuilder<NodePackagingType>> fn)	Contains statistics about OpenSearch distributions installed on selected nodes.
final ClusterNodes.Builder	packagingTypes(List<NodePackagingType> list)	Contains statistics about OpenSearch distributions installed on selected nodes.
final ClusterNodes.Builder	packagingTypes(NodePackagingType value, NodePackagingType... values)	Contains statistics about OpenSearch distributions installed on selected nodes.
final ClusterNodes.Builder	plugins(Function<PluginStats.Builder,ObjectBuilder<PluginStats>> fn)	Contains statistics about installed plugins and modules by selected nodes.
final ClusterNodes.Builder	plugins(List<PluginStats> list)	Contains statistics about installed plugins and modules by selected nodes.
final ClusterNodes.Builder	plugins(PluginStats value, PluginStats... values)	Contains statistics about installed plugins and modules by selected nodes.
final ClusterNodes.Builder	process(Function<ClusterProcess.Builder,ObjectBuilder<ClusterProcess>> fn)	Contains statistics about processes used by selected nodes.
final ClusterNodes.Builder	process(ClusterProcess value)	Contains statistics about processes used by selected nodes.
final ClusterNodes.Builder	versions(String value, String... values)	Array of OpenSearch versions used on selected nodes.
final ClusterNodes.Builder	versions(List<String> list)	Array of OpenSearch versions used on 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 ClusterNodes.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<ClusterNodes.Builder,ClusterNodes>

Returns:

a new builder instance.

count

@Nonnull
public final ClusterNodes.Builder count(@Nullable
 ClusterNodeCount value)

Contains counts for nodes selected by the request's node filters.

API name: count

count

@Nonnull
public final ClusterNodes.Builder count(Function<ClusterNodeCount.Builder,ObjectBuilder<ClusterNodeCount>> fn)

Contains counts for nodes selected by the request's node filters.

API name: count

discoveryTypes

@Nonnull
public final ClusterNodes.Builder discoveryTypes(Map<String,Integer> map)

Contains statistics about the discovery types used by selected nodes.

API name: discovery_types

Adds all elements of map to discoveryTypes.

discoveryTypes

@Nonnull
public final ClusterNodes.Builder discoveryTypes(String key,
 Integer value)

Contains statistics about the discovery types used by selected nodes.

API name: discovery_types

Adds an entry to discoveryTypes.

fs

@Nonnull
public final ClusterNodes.Builder fs(@Nullable
 ClusterFileSystem value)

Contains statistics about file stores by selected nodes.

API name: fs

fs

@Nonnull
public final ClusterNodes.Builder fs(Function<ClusterFileSystem.Builder,ObjectBuilder<ClusterFileSystem>> fn)

Contains statistics about file stores by selected nodes.

API name: fs

indexingPressure

@Nonnull
public final ClusterNodes.Builder indexingPressure(@Nullable
 IndexingPressure value)

API name: indexing_pressure

indexingPressure

@Nonnull
public final ClusterNodes.Builder indexingPressure(Function<IndexingPressure.Builder,ObjectBuilder<IndexingPressure>> fn)

API name: indexing_pressure

ingest

@Nonnull
public final ClusterNodes.Builder ingest(@Nullable
 ClusterIngest value)

API name: ingest

ingest

@Nonnull
public final ClusterNodes.Builder ingest(Function<ClusterIngest.Builder,ObjectBuilder<ClusterIngest>> fn)

API name: ingest

jvm

@Nonnull
public final ClusterNodes.Builder jvm(@Nullable
 ClusterJvm value)

Contains statistics about the Java Virtual Machines (JVMs) used by selected nodes.

API name: jvm

jvm

@Nonnull
public final ClusterNodes.Builder jvm(Function<ClusterJvm.Builder,ObjectBuilder<ClusterJvm>> fn)

Contains statistics about the Java Virtual Machines (JVMs) used by selected nodes.

API name: jvm

networkTypes

@Nonnull
public final ClusterNodes.Builder networkTypes(@Nullable
 ClusterNetworkTypes value)

Contains statistics about the transport and HTTP networks used by selected nodes.

API name: network_types

networkTypes

@Nonnull
public final ClusterNodes.Builder networkTypes(Function<ClusterNetworkTypes.Builder,ObjectBuilder<ClusterNetworkTypes>> fn)

Contains statistics about the transport and HTTP networks used by selected nodes.

API name: network_types

os

@Nonnull
public final ClusterNodes.Builder os(@Nullable
 ClusterOperatingSystem value)

Contains statistics about the operating systems used by selected nodes.

API name: os

os

@Nonnull
public final ClusterNodes.Builder os(Function<ClusterOperatingSystem.Builder,ObjectBuilder<ClusterOperatingSystem>> fn)

Contains statistics about the operating systems used by selected nodes.

API name: os

packagingTypes

@Nonnull
public final ClusterNodes.Builder packagingTypes(List<NodePackagingType> list)

Contains statistics about OpenSearch distributions installed on selected nodes.

API name: packaging_types

Adds all elements of list to packagingTypes.

packagingTypes

@Nonnull
public final ClusterNodes.Builder packagingTypes(NodePackagingType value,
 NodePackagingType... values)

Contains statistics about OpenSearch distributions installed on selected nodes.

API name: packaging_types

Adds one or more values to packagingTypes.

packagingTypes

@Nonnull
public final ClusterNodes.Builder packagingTypes(Function<NodePackagingType.Builder,ObjectBuilder<NodePackagingType>> fn)

Contains statistics about OpenSearch distributions installed on selected nodes.

API name: packaging_types

Adds a value to packagingTypes using a builder lambda.

plugins

@Nonnull
public final ClusterNodes.Builder plugins(List<PluginStats> list)

Contains statistics about installed plugins and modules by selected nodes. If no plugins or modules are installed, this array is empty.

API name: plugins

Adds all elements of list to plugins.

plugins

@Nonnull
public final ClusterNodes.Builder plugins(PluginStats value,
 PluginStats... values)

Contains statistics about installed plugins and modules by selected nodes. If no plugins or modules are installed, this array is empty.

API name: plugins

Adds one or more values to plugins.

plugins

@Nonnull
public final ClusterNodes.Builder plugins(Function<PluginStats.Builder,ObjectBuilder<PluginStats>> fn)

Contains statistics about installed plugins and modules by selected nodes. If no plugins or modules are installed, this array is empty.

API name: plugins

Adds a value to plugins using a builder lambda.

process

@Nonnull
public final ClusterNodes.Builder process(@Nullable
 ClusterProcess value)

Contains statistics about processes used by selected nodes.

API name: process

process

@Nonnull
public final ClusterNodes.Builder process(Function<ClusterProcess.Builder,ObjectBuilder<ClusterProcess>> fn)

Contains statistics about processes used by selected nodes.

API name: process

versions

@Nonnull
public final ClusterNodes.Builder versions(List<String> list)

Array of OpenSearch versions used on selected nodes.

API name: versions

Adds all elements of list to versions.

versions

@Nonnull
public final ClusterNodes.Builder versions(String value,
 String... values)

Array of OpenSearch versions used on selected nodes.

API name: versions

Adds one or more values to versions.

build

@Nonnull
public ClusterNodes build()

Builds a ClusterNodes.

Specified by:

build in interface ObjectBuilder<ClusterNodes>

Throws:

NullPointerException - if some of the required fields are null.