Package org.opensearch.client.opensearch.nodes

Class OpenSearchNodesAsyncClient

java.lang.Object

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

org.opensearch.client.opensearch.nodes.OpenSearchNodesAsyncClient

public class OpenSearchNodesAsyncClient
extends ApiClient<OpenSearchTransport,OpenSearchNodesAsyncClient>

Client for the nodes namespace.

Field Summary

Fields inherited from class org.opensearch.client.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
java.util.concurrent.CompletableFuture<HotThreadsResponse>	hotThreads()	Returns information about hot threads on each node in the cluster.
java.util.concurrent.CompletableFuture<HotThreadsResponse>	hotThreads(java.util.function.Function<HotThreadsRequest.Builder,ObjectBuilder<HotThreadsRequest>> fn)	Returns information about hot threads on each node in the cluster.
java.util.concurrent.CompletableFuture<HotThreadsResponse>	hotThreads(HotThreadsRequest request)	Returns information about hot threads on each node in the cluster.
java.util.concurrent.CompletableFuture<NodesInfoResponse>	info()	Returns information about nodes in the cluster.
java.util.concurrent.CompletableFuture<NodesInfoResponse>	info(java.util.function.Function<NodesInfoRequest.Builder,ObjectBuilder<NodesInfoRequest>> fn)	Returns information about nodes in the cluster.
java.util.concurrent.CompletableFuture<NodesInfoResponse>	info(NodesInfoRequest request)	Returns information about nodes in the cluster.
java.util.concurrent.CompletableFuture<ReloadSecureSettingsResponse>	reloadSecureSettings()	Reloads secure settings.
java.util.concurrent.CompletableFuture<ReloadSecureSettingsResponse>	reloadSecureSettings(java.util.function.Function<ReloadSecureSettingsRequest.Builder,ObjectBuilder<ReloadSecureSettingsRequest>> fn)	Reloads secure settings.
java.util.concurrent.CompletableFuture<ReloadSecureSettingsResponse>	reloadSecureSettings(ReloadSecureSettingsRequest request)	Reloads secure settings.
java.util.concurrent.CompletableFuture<NodesStatsResponse>	stats()	Returns statistical information about nodes in the cluster.
java.util.concurrent.CompletableFuture<NodesStatsResponse>	stats(java.util.function.Function<NodesStatsRequest.Builder,ObjectBuilder<NodesStatsRequest>> fn)	Returns statistical information about nodes in the cluster.
java.util.concurrent.CompletableFuture<NodesStatsResponse>	stats(NodesStatsRequest request)	Returns statistical information about nodes in the cluster.
java.util.concurrent.CompletableFuture<NodesUsageResponse>	usage()	Returns low-level information about REST actions usage on nodes.
java.util.concurrent.CompletableFuture<NodesUsageResponse>	usage(java.util.function.Function<NodesUsageRequest.Builder,ObjectBuilder<NodesUsageRequest>> fn)	Returns low-level information about REST actions usage on nodes.
java.util.concurrent.CompletableFuture<NodesUsageResponse>	usage(NodesUsageRequest request)	Returns low-level information about REST actions usage on nodes.
OpenSearchNodesAsyncClient	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

OpenSearchNodesAsyncClient

public OpenSearchNodesAsyncClient(OpenSearchTransport transport)

OpenSearchNodesAsyncClient

public OpenSearchNodesAsyncClient(OpenSearchTransport transport,
                                  @Nullable
                                  TransportOptions transportOptions)

Method Detail

withTransportOptions

public OpenSearchNodesAsyncClient withTransportOptions(@Nullable
                                                       TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<OpenSearchTransport,OpenSearchNodesAsyncClient>

hotThreads

public java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<NodesInfoResponse> info(NodesInfoRequest request)
                                                               throws java.io.IOException,
                                                                      OpenSearchException

Returns information about nodes in the cluster.

Throws:

java.io.IOException

OpenSearchException

info

public final java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<NodesInfoResponse> info()
                                                               throws java.io.IOException,
                                                                      OpenSearchException

Returns information about nodes in the cluster.

Throws:

java.io.IOException

OpenSearchException

reloadSecureSettings

public java.util.concurrent.CompletableFuture<ReloadSecureSettingsResponse> reloadSecureSettings(ReloadSecureSettingsRequest request)
                                                                                          throws java.io.IOException,
                                                                                                 OpenSearchException

Reloads secure settings.

Throws:

java.io.IOException

OpenSearchException

reloadSecureSettings

public final java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<ReloadSecureSettingsResponse> reloadSecureSettings()
                                                                                          throws java.io.IOException,
                                                                                                 OpenSearchException

Reloads secure settings.

Throws:

java.io.IOException

OpenSearchException

stats

public java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<NodesStatsResponse> stats()
                                                                 throws java.io.IOException,
                                                                        OpenSearchException

Returns statistical information about nodes in the cluster.

Throws:

java.io.IOException

OpenSearchException

usage

public java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<NodesUsageResponse> usage()
                                                                 throws java.io.IOException,
                                                                        OpenSearchException

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

Throws:

java.io.IOException

OpenSearchException