Package org.opensearch.client.opensearch.api.nodes

Class NodesClient

java.lang.Object

org.opensearch.client.base.ApiClient<NodesClient>

org.opensearch.client.opensearch.api.nodes.NodesClient

public class NodesClient
extends ApiClient<NodesClient>

Client for the nodes namespace.

Field Summary

Fields inherited from class org.opensearch.client.base.ApiClient

requestOptions, transport

Constructor Summary

Constructors

Constructor	Description
NodesClient(Transport transport)
NodesClient(Transport transport, org.opensearch.client.RequestOptions options)

Method Summary

Modifier and Type	Method	Description
HotThreadsResponse	hotThreads(java.util.function.Function<HotThreadsRequest.Builder,ObjectBuilder<HotThreadsRequest>> fn)	Returns information about hot threads on each node in the cluster.
HotThreadsResponse	hotThreads(HotThreadsRequest request)	Returns information about hot threads on each node in the cluster.
InfoResponse	info(java.util.function.Function<InfoRequest.Builder,ObjectBuilder<InfoRequest>> fn)	Returns information about nodes in the cluster.
InfoResponse	info(InfoRequest request)	Returns information about nodes in the cluster.
ReloadSecureSettingsResponse	reloadSecureSettings(java.util.function.Function<ReloadSecureSettingsRequest.Builder,ObjectBuilder<ReloadSecureSettingsRequest>> fn)	Reloads secure settings.
ReloadSecureSettingsResponse	reloadSecureSettings(ReloadSecureSettingsRequest request)	Reloads secure settings.
StatsResponse	stats(java.util.function.Function<StatsRequest.Builder,ObjectBuilder<StatsRequest>> fn)	Returns statistical information about nodes in the cluster.
StatsResponse	stats(StatsRequest request)	Returns statistical information about nodes in the cluster.
UsageResponse	usage(java.util.function.Function<UsageRequest.Builder,ObjectBuilder<UsageRequest>> fn)	Returns low-level information about REST actions usage on nodes.
UsageResponse	usage(UsageRequest request)	Returns low-level information about REST actions usage on nodes.
NodesClient	withRequestOptions(java.util.function.Function<org.opensearch.client.RequestOptions.Builder,org.opensearch.client.RequestOptions.Builder> fn)	Creates a new NodesClient(org.opensearch.client.base.Transport, org.opensearch.client.RequestOptions) with specific request options, inheriting existing options.
NodesClient	withRequestOptions(org.opensearch.client.RequestOptions options)	Creates a new NodesClient(org.opensearch.client.base.Transport, org.opensearch.client.RequestOptions) with specific request options.

Methods inherited from class org.opensearch.client.base.ApiClient

getDeserializer, requestOptions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

NodesClient

public NodesClient(Transport transport)

NodesClient

public NodesClient(Transport transport, org.opensearch.client.RequestOptions options)

Method Details

hotThreads

public HotThreadsResponse hotThreads(HotThreadsRequest request) throws java.io.IOException

Returns information about hot threads on each node in the cluster.

Throws:

java.io.IOException

hotThreads

public final HotThreadsResponse hotThreads(java.util.function.Function<HotThreadsRequest.Builder,ObjectBuilder<HotThreadsRequest>> fn) throws java.io.IOException

Returns information about hot threads on each node in the cluster.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

info

public InfoResponse info(InfoRequest request) throws java.io.IOException

Returns information about nodes in the cluster.

Throws:

java.io.IOException

info

public final InfoResponse info(java.util.function.Function<InfoRequest.Builder,ObjectBuilder<InfoRequest>> fn) throws java.io.IOException

Returns information about nodes in the cluster.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

reloadSecureSettings

public ReloadSecureSettingsResponse reloadSecureSettings(ReloadSecureSettingsRequest request) throws java.io.IOException

Reloads secure settings.

Throws:

java.io.IOException

reloadSecureSettings

public final ReloadSecureSettingsResponse reloadSecureSettings(java.util.function.Function<ReloadSecureSettingsRequest.Builder,ObjectBuilder<ReloadSecureSettingsRequest>> fn) throws java.io.IOException

Reloads secure settings.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

stats

public StatsResponse stats(StatsRequest request) throws java.io.IOException

Returns statistical information about nodes in the cluster.

Throws:

java.io.IOException

stats

public final StatsResponse stats(java.util.function.Function<StatsRequest.Builder,ObjectBuilder<StatsRequest>> fn) throws java.io.IOException

Returns statistical information about nodes in the cluster.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

usage

public UsageResponse usage(UsageRequest request) throws java.io.IOException

Returns low-level information about REST actions usage on nodes.

Throws:

java.io.IOException

usage

public final UsageResponse usage(java.util.function.Function<UsageRequest.Builder,ObjectBuilder<UsageRequest>> fn) throws java.io.IOException

Returns low-level information about REST actions usage on nodes.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

withRequestOptions

public NodesClient withRequestOptions(@Nullable org.opensearch.client.RequestOptions options)

Creates a new NodesClient(org.opensearch.client.base.Transport, org.opensearch.client.RequestOptions) with specific request options.

Specified by:

withRequestOptions in class ApiClient<NodesClient>

withRequestOptions

public NodesClient withRequestOptions(java.util.function.Function<org.opensearch.client.RequestOptions.Builder,org.opensearch.client.RequestOptions.Builder> fn)

Creates a new NodesClient(org.opensearch.client.base.Transport, org.opensearch.client.RequestOptions) with specific request options, inheriting existing options.

Parameters:

fn - a function taking an options builder initialized with the current request options, or initialized with default values.