Package org.opensearch.client.opensearch.nodes.info

Class NodeInfo.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.nodes.info.NodeInfo.Builder

All Implemented Interfaces:

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

Enclosing class:

NodeInfo

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

Builder for NodeInfo.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final NodeInfo.Builder	aggregations(String key, Function<NodeInfoAggregation.Builder,ObjectBuilder<NodeInfoAggregation>> fn)	Information about available aggregation types.
final NodeInfo.Builder	aggregations(String key, NodeInfoAggregation value)	Information about available aggregation types.
final NodeInfo.Builder	aggregations(Map<String,NodeInfoAggregation> map)	Information about available aggregation types.
final NodeInfo.Builder	attributes(String key, String value)	The custom attributes of the node.
final NodeInfo.Builder	attributes(Map<String,String> map)	The custom attributes of the node.
NodeInfo	build()	Builds a NodeInfo.
final NodeInfo.Builder	buildFlavor(String value)	API name: build_flavor
final NodeInfo.Builder	buildHash(String value)	Required - Short hash of the last git commit in this release.
final NodeInfo.Builder	buildType(String value)	Required - The type of build, such as tar, docker, rpm.
NodeInfo.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final NodeInfo.Builder	host(String value)	API name: host
final NodeInfo.Builder	http(Function<NodeInfoHttp.Builder,ObjectBuilder<NodeInfoHttp>> fn)	API name: http
final NodeInfo.Builder	http(NodeInfoHttp value)	API name: http
final NodeInfo.Builder	ingest(Function<NodeInfoIngest.Builder,ObjectBuilder<NodeInfoIngest>> fn)	API name: ingest
final NodeInfo.Builder	ingest(NodeInfoIngest value)	API name: ingest
final NodeInfo.Builder	ip(String value)	API name: ip
final NodeInfo.Builder	jvm(Function<NodeJvmInfo.Builder,ObjectBuilder<NodeJvmInfo>> fn)	API name: jvm
final NodeInfo.Builder	jvm(NodeJvmInfo value)	API name: jvm
final NodeInfo.Builder	modules(Function<PluginStats.Builder,ObjectBuilder<PluginStats>> fn)	The list of modules installed on the node.
final NodeInfo.Builder	modules(List<PluginStats> list)	The list of modules installed on the node.
final NodeInfo.Builder	modules(PluginStats value, PluginStats... values)	The list of modules installed on the node.
final NodeInfo.Builder	name(String value)	Required - API name: name
final NodeInfo.Builder	network(Function<NodeInfoNetwork.Builder,ObjectBuilder<NodeInfoNetwork>> fn)	API name: network
final NodeInfo.Builder	network(NodeInfoNetwork value)	API name: network
final NodeInfo.Builder	os(Function<NodeOperatingSystemInfo.Builder,ObjectBuilder<NodeOperatingSystemInfo>> fn)	API name: os
final NodeInfo.Builder	os(NodeOperatingSystemInfo value)	API name: os
final NodeInfo.Builder	plugins(Function<PluginStats.Builder,ObjectBuilder<PluginStats>> fn)	The list of plugins installed on the node.
final NodeInfo.Builder	plugins(List<PluginStats> list)	The list of plugins installed on the node.
final NodeInfo.Builder	plugins(PluginStats value, PluginStats... values)	The list of plugins installed on the node.
final NodeInfo.Builder	process(Function<NodeProcessInfo.Builder,ObjectBuilder<NodeProcessInfo>> fn)	API name: process
final NodeInfo.Builder	process(NodeProcessInfo value)	API name: process
final NodeInfo.Builder	roles(List<NodeRole> list)	Required - API name: roles
final NodeInfo.Builder	roles(NodeRole value, NodeRole... values)	Required - API name: roles
final NodeInfo.Builder	searchPipelines(Function<NodeInfoSearchPipelines.Builder,ObjectBuilder<NodeInfoSearchPipelines>> fn)	API name: search_pipelines
final NodeInfo.Builder	searchPipelines(NodeInfoSearchPipelines value)	API name: search_pipelines
final NodeInfo.Builder	settings(Function<NodeInfoSettings.Builder,ObjectBuilder<NodeInfoSettings>> fn)	API name: settings
final NodeInfo.Builder	settings(NodeInfoSettings value)	API name: settings
final NodeInfo.Builder	threadPool(String key, Function<NodeThreadPoolInfo.Builder,ObjectBuilder<NodeThreadPoolInfo>> fn)	Information about thread pool configurations.
final NodeInfo.Builder	threadPool(String key, NodeThreadPoolInfo value)	Information about thread pool configurations.
final NodeInfo.Builder	threadPool(Map<String,NodeThreadPoolInfo> map)	Information about thread pool configurations.
final NodeInfo.Builder	totalIndexingBuffer(JsonData value)	Total heap allowed to be used to hold recently indexed documents before they must be written to disk.
final NodeInfo.Builder	totalIndexingBufferInBytes(JsonData value)	API name: total_indexing_buffer_in_bytes
final NodeInfo.Builder	transport(Function<NodeInfoTransport.Builder,ObjectBuilder<NodeInfoTransport>> fn)	API name: transport
final NodeInfo.Builder	transport(NodeInfoTransport value)	API name: transport
final NodeInfo.Builder	transportAddress(String value)	API name: transport_address
final NodeInfo.Builder	version(String value)	Required - API name: version

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 NodeInfo.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<NodeInfo.Builder,NodeInfo>

Returns:

a new builder instance.

aggregations

@Nonnull
public final NodeInfo.Builder aggregations(Map<String,NodeInfoAggregation> map)

Information about available aggregation types.

API name: aggregations

Adds all elements of map to aggregations.

aggregations

@Nonnull
public final NodeInfo.Builder aggregations(String key,
 NodeInfoAggregation value)

Information about available aggregation types.

API name: aggregations

Adds an entry to aggregations.

aggregations

@Nonnull
public final NodeInfo.Builder aggregations(String key,
 Function<NodeInfoAggregation.Builder,ObjectBuilder<NodeInfoAggregation>> fn)

Information about available aggregation types.

API name: aggregations

Adds a value to aggregations using a builder lambda.

attributes

@Nonnull
public final NodeInfo.Builder attributes(Map<String,String> map)

The custom attributes of the node.

API name: attributes

Adds all elements of map to attributes.

attributes

@Nonnull
public final NodeInfo.Builder attributes(String key,
 String value)

The custom attributes of the node.

API name: attributes

Adds an entry to attributes.

buildFlavor

@Nonnull
public final NodeInfo.Builder buildFlavor(@Nullable
 String value)

API name: build_flavor

buildHash

@Nonnull
public final NodeInfo.Builder buildHash(String value)

Required - Short hash of the last git commit in this release.

API name: build_hash

buildType

@Nonnull
public final NodeInfo.Builder buildType(String value)

Required - The type of build, such as tar, docker, rpm.

API name: build_type

host

@Nonnull
public final NodeInfo.Builder host(@Nullable
 String value)

API name: host

http

@Nonnull
public final NodeInfo.Builder http(@Nullable
 NodeInfoHttp value)

API name: http

http

@Nonnull
public final NodeInfo.Builder http(Function<NodeInfoHttp.Builder,ObjectBuilder<NodeInfoHttp>> fn)

API name: http

ingest

@Nonnull
public final NodeInfo.Builder ingest(@Nullable
 NodeInfoIngest value)

API name: ingest

ingest

@Nonnull
public final NodeInfo.Builder ingest(Function<NodeInfoIngest.Builder,ObjectBuilder<NodeInfoIngest>> fn)

API name: ingest

ip

@Nonnull
public final NodeInfo.Builder ip(@Nullable
 String value)

API name: ip

jvm

@Nonnull
public final NodeInfo.Builder jvm(@Nullable
 NodeJvmInfo value)

API name: jvm

jvm

@Nonnull
public final NodeInfo.Builder jvm(Function<NodeJvmInfo.Builder,ObjectBuilder<NodeJvmInfo>> fn)

API name: jvm

modules

@Nonnull
public final NodeInfo.Builder modules(List<PluginStats> list)

The list of modules installed on the node.

API name: modules

Adds all elements of list to modules.

modules

@Nonnull
public final NodeInfo.Builder modules(PluginStats value,
 PluginStats... values)

The list of modules installed on the node.

API name: modules

Adds one or more values to modules.

modules

@Nonnull
public final NodeInfo.Builder modules(Function<PluginStats.Builder,ObjectBuilder<PluginStats>> fn)

The list of modules installed on the node.

API name: modules

Adds a value to modules using a builder lambda.

name

@Nonnull
public final NodeInfo.Builder name(String value)

Required - API name: name

network

@Nonnull
public final NodeInfo.Builder network(@Nullable
 NodeInfoNetwork value)

API name: network

network

@Nonnull
public final NodeInfo.Builder network(Function<NodeInfoNetwork.Builder,ObjectBuilder<NodeInfoNetwork>> fn)

API name: network

os

@Nonnull
public final NodeInfo.Builder os(@Nullable
 NodeOperatingSystemInfo value)

API name: os

os

@Nonnull
public final NodeInfo.Builder os(Function<NodeOperatingSystemInfo.Builder,ObjectBuilder<NodeOperatingSystemInfo>> fn)

API name: os

plugins

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

The list of plugins installed on the node.

API name: plugins

Adds all elements of list to plugins.

plugins

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

The list of plugins installed on the node.

API name: plugins

Adds one or more values to plugins.

plugins

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

The list of plugins installed on the node.

API name: plugins

Adds a value to plugins using a builder lambda.

process

@Nonnull
public final NodeInfo.Builder process(@Nullable
 NodeProcessInfo value)

API name: process

process

@Nonnull
public final NodeInfo.Builder process(Function<NodeProcessInfo.Builder,ObjectBuilder<NodeProcessInfo>> fn)

API name: process

roles

@Nonnull
public final NodeInfo.Builder roles(List<NodeRole> list)

Required - API name: roles

Adds all elements of list to roles.

roles

@Nonnull
public final NodeInfo.Builder roles(NodeRole value,
 NodeRole... values)

Required - API name: roles

Adds one or more values to roles.

searchPipelines

@Nonnull
public final NodeInfo.Builder searchPipelines(@Nullable
 NodeInfoSearchPipelines value)

API name: search_pipelines

searchPipelines

@Nonnull
public final NodeInfo.Builder searchPipelines(Function<NodeInfoSearchPipelines.Builder,ObjectBuilder<NodeInfoSearchPipelines>> fn)

API name: search_pipelines

settings

@Nonnull
public final NodeInfo.Builder settings(@Nullable
 NodeInfoSettings value)

API name: settings

settings

@Nonnull
public final NodeInfo.Builder settings(Function<NodeInfoSettings.Builder,ObjectBuilder<NodeInfoSettings>> fn)

API name: settings

threadPool

@Nonnull
public final NodeInfo.Builder threadPool(Map<String,NodeThreadPoolInfo> map)

Information about thread pool configurations.

API name: thread_pool

Adds all elements of map to threadPool.

threadPool

@Nonnull
public final NodeInfo.Builder threadPool(String key,
 NodeThreadPoolInfo value)

Information about thread pool configurations.

API name: thread_pool

Adds an entry to threadPool.

threadPool

@Nonnull
public final NodeInfo.Builder threadPool(String key,
 Function<NodeThreadPoolInfo.Builder,ObjectBuilder<NodeThreadPoolInfo>> fn)

Information about thread pool configurations.

API name: thread_pool

Adds a value to threadPool using a builder lambda.

totalIndexingBuffer

@Nonnull
public final NodeInfo.Builder totalIndexingBuffer(@Nullable
 JsonData value)

Total heap allowed to be used to hold recently indexed documents before they must be written to disk. This size is a shared pool across all shards on this node, and is controlled by Indexing Buffer settings.

API name: total_indexing_buffer

totalIndexingBufferInBytes

@Nonnull
public final NodeInfo.Builder totalIndexingBufferInBytes(@Nullable
 JsonData value)

API name: total_indexing_buffer_in_bytes

transport

@Nonnull
public final NodeInfo.Builder transport(@Nullable
 NodeInfoTransport value)

API name: transport

transport

@Nonnull
public final NodeInfo.Builder transport(Function<NodeInfoTransport.Builder,ObjectBuilder<NodeInfoTransport>> fn)

API name: transport

transportAddress

@Nonnull
public final NodeInfo.Builder transportAddress(@Nullable
 String value)

API name: transport_address

version

@Nonnull
public final NodeInfo.Builder version(String value)

Required - API name: version

build

@Nonnull
public NodeInfo build()

Builds a NodeInfo.

Specified by:

build in interface ObjectBuilder<NodeInfo>

Throws:

NullPointerException - if some of the required fields are null.