Package org.opensearch.client.opensearch.nodes

Class OpenSearchNodesClient

java.lang.Object

org.opensearch.client.ApiClient<OpenSearchTransport,OpenSearchNodesClient>

org.opensearch.client.opensearch.nodes.OpenSearchNodesClient

public class OpenSearchNodesClient
extends ApiClient<OpenSearchTransport,OpenSearchNodesClient>

Client for the nodes namespace.

Field Summary

Fields inherited from class org.opensearch.client.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
OpenSearchNodesClient(OpenSearchTransport transport)
OpenSearchNodesClient(OpenSearchTransport transport, TransportOptions transportOptions)

Method Summary

Modifier and Type	Method	Description
HotThreadsResponse	hotThreads()	Returns information about hot threads on each node in the cluster.
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.
NodesInfoResponse	info()	Returns information about nodes in the cluster.
NodesInfoResponse	info(java.util.function.Function<NodesInfoRequest.Builder,ObjectBuilder<NodesInfoRequest>> fn)	Returns information about nodes in the cluster.
NodesInfoResponse	info(NodesInfoRequest request)	Returns information about nodes in the cluster.
ReloadSecureSettingsResponse	reloadSecureSettings()	Reloads secure settings.
ReloadSecureSettingsResponse	reloadSecureSettings(java.util.function.Function<ReloadSecureSettingsRequest.Builder,ObjectBuilder<ReloadSecureSettingsRequest>> fn)	Reloads secure settings.
ReloadSecureSettingsResponse	reloadSecureSettings(ReloadSecureSettingsRequest request)	Reloads secure settings.
NodesStatsResponse	stats()	Returns statistical information about nodes in the cluster.
NodesStatsResponse	stats(java.util.function.Function<NodesStatsRequest.Builder,ObjectBuilder<NodesStatsRequest>> fn)	Returns statistical information about nodes in the cluster.
NodesStatsResponse	stats(NodesStatsRequest request)	Returns statistical information about nodes in the cluster.
NodesUsageResponse	usage()	Returns low-level information about REST actions usage on nodes.
NodesUsageResponse	usage(java.util.function.Function<NodesUsageRequest.Builder,ObjectBuilder<NodesUsageRequest>> fn)	Returns low-level information about REST actions usage on nodes.
NodesUsageResponse	usage(NodesUsageRequest request)	Returns low-level information about REST actions usage on nodes.
OpenSearchNodesClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class org.opensearch.client.ApiClient

_transport, _transportOptions, getDeserializer

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenSearchNodesClient

public OpenSearchNodesClient(OpenSearchTransport transport)

OpenSearchNodesClient

public OpenSearchNodesClient(OpenSearchTransport transport,
                             @Nullable
                             TransportOptions transportOptions)

Method Detail

withTransportOptions

public OpenSearchNodesClient withTransportOptions(@Nullable
                                                  TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<OpenSearchTransport,OpenSearchNodesClient>

hotThreads

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

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

Throws:

java.io.IOException

OpenSearchException

hotThreads

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

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

Parameters:

fn - a function that initializes a builder to create the HotThreadsRequest

Throws:

java.io.IOException

OpenSearchException

hotThreads

public HotThreadsResponse hotThreads()
                              throws java.io.IOException,
                                     OpenSearchException

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

Throws:

java.io.IOException

OpenSearchException

info

public NodesInfoResponse info(NodesInfoRequest request)
                       throws java.io.IOException,
                              OpenSearchException

Returns information about nodes in the cluster.

Throws:

java.io.IOException

OpenSearchException

info

public final NodesInfoResponse info(java.util.function.Function<NodesInfoRequest.Builder,ObjectBuilder<NodesInfoRequest>> fn)
                             throws java.io.IOException,
                                    OpenSearchException

Returns information about nodes in the cluster.

Parameters:

fn - a function that initializes a builder to create the NodesInfoRequest

Throws:

java.io.IOException

OpenSearchException

info

public NodesInfoResponse info()
                       throws java.io.IOException,
                              OpenSearchException

Returns information about nodes in the cluster.

Throws:

java.io.IOException

OpenSearchException

reloadSecureSettings

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

Reloads secure settings.

Throws:

java.io.IOException

OpenSearchException

reloadSecureSettings

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

Reloads secure settings.

Parameters:

fn - a function that initializes a builder to create the ReloadSecureSettingsRequest

Throws:

java.io.IOException

OpenSearchException

reloadSecureSettings

public ReloadSecureSettingsResponse reloadSecureSettings()
                                                  throws java.io.IOException,
                                                         OpenSearchException

Reloads secure settings.

Throws:

java.io.IOException

OpenSearchException

stats

public NodesStatsResponse stats(NodesStatsRequest request)
                         throws java.io.IOException,
                                OpenSearchException

Returns statistical information about nodes in the cluster.

Throws:

java.io.IOException

OpenSearchException

stats

public final NodesStatsResponse stats(java.util.function.Function<NodesStatsRequest.Builder,ObjectBuilder<NodesStatsRequest>> fn)
                               throws java.io.IOException,
                                      OpenSearchException

Returns statistical information about nodes in the cluster.

Parameters:

fn - a function that initializes a builder to create the NodesStatsRequest

Throws:

java.io.IOException

OpenSearchException

stats

public NodesStatsResponse stats()
                         throws java.io.IOException,
                                OpenSearchException

Returns statistical information about nodes in the cluster.

Throws:

java.io.IOException

OpenSearchException

usage

public NodesUsageResponse usage(NodesUsageRequest request)
                         throws java.io.IOException,
                                OpenSearchException

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

Throws:

java.io.IOException

OpenSearchException

usage

public final NodesUsageResponse usage(java.util.function.Function<NodesUsageRequest.Builder,ObjectBuilder<NodesUsageRequest>> fn)
                               throws java.io.IOException,
                                      OpenSearchException

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

Parameters:

fn - a function that initializes a builder to create the NodesUsageRequest

Throws:

java.io.IOException

OpenSearchException

usage

public NodesUsageResponse usage()
                         throws java.io.IOException,
                                OpenSearchException

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

Throws:

java.io.IOException

OpenSearchException