Package org.opensearch.client.opensearch.nodes

Class OpenSearchNodesClientBase<Self extends OpenSearchNodesClientBase<Self>>

java.lang.Object

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

org.opensearch.client.opensearch.nodes.OpenSearchNodesClientBase<Self>

Direct Known Subclasses:

OpenSearchNodesClient

@Generated("org.opensearch.client.codegen.CodeGenerator")
public abstract class OpenSearchNodesClientBase<Self extends OpenSearchNodesClientBase<Self>>
extends ApiClient<OpenSearchTransport,Self>

Client for the nodes namespace.

Field Summary

Fields inherited from class org.opensearch.client.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
OpenSearchNodesClientBase(OpenSearchTransport transport, TransportOptions transportOptions)

Method Summary

Modifier and Type	Method	Description
final NodesInfoResponse	info()	Returns information about nodes in the cluster.
final NodesInfoResponse	info(Function<NodesInfoRequest.Builder,ObjectBuilder<NodesInfoRequest>> fn)	Returns information about nodes in the cluster.
NodesInfoResponse	info(NodesInfoRequest request)	Returns information about nodes in the cluster.
final ReloadSecureSettingsResponse	reloadSecureSettings()	Reloads secure settings.
final ReloadSecureSettingsResponse	reloadSecureSettings(Function<ReloadSecureSettingsRequest.Builder,ObjectBuilder<ReloadSecureSettingsRequest>> fn)	Reloads secure settings.
ReloadSecureSettingsResponse	reloadSecureSettings(ReloadSecureSettingsRequest request)	Reloads secure settings.
final NodesStatsResponse	stats()	Returns statistical information about nodes in the cluster.
final NodesStatsResponse	stats(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.
final NodesUsageResponse	usage()	Returns low-level information about REST actions usage on nodes.
final NodesUsageResponse	usage(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.

Methods inherited from class org.opensearch.client.ApiClient

_transport, _transportOptions, getDeserializer, withTransportOptions

Methods inherited from class java.lang.Object

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

Constructor Details

OpenSearchNodesClientBase

public OpenSearchNodesClientBase(OpenSearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

info

public NodesInfoResponse info(NodesInfoRequest request)
                       throws IOException,
OpenSearchException

Returns information about nodes in the cluster.

Throws:

IOException

OpenSearchException

info

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

Returns information about nodes in the cluster.

Parameters:

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

Throws:

IOException

OpenSearchException

info

public final NodesInfoResponse info()
                             throws IOException,
OpenSearchException

Returns information about nodes in the cluster.

Throws:

IOException

OpenSearchException

reloadSecureSettings

public ReloadSecureSettingsResponse reloadSecureSettings(ReloadSecureSettingsRequest request)
                                                  throws IOException,
OpenSearchException

Reloads secure settings.

Throws:

IOException

OpenSearchException

reloadSecureSettings

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

Reloads secure settings.

Parameters:

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

Throws:

IOException

OpenSearchException

reloadSecureSettings

public final ReloadSecureSettingsResponse reloadSecureSettings()
                                                        throws IOException,
OpenSearchException

Reloads secure settings.

Throws:

IOException

OpenSearchException

stats

public NodesStatsResponse stats(NodesStatsRequest request)
                         throws IOException,
OpenSearchException

Returns statistical information about nodes in the cluster.

Throws:

IOException

OpenSearchException

stats

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

Returns statistical information about nodes in the cluster.

Parameters:

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

Throws:

IOException

OpenSearchException

stats

public final NodesStatsResponse stats()
                               throws IOException,
OpenSearchException

Returns statistical information about nodes in the cluster.

Throws:

IOException

OpenSearchException

usage

public NodesUsageResponse usage(NodesUsageRequest request)
                         throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

usage

public final NodesUsageResponse usage(Function<NodesUsageRequest.Builder,ObjectBuilder<NodesUsageRequest>> fn)
                               throws 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:

IOException

OpenSearchException

usage

public final NodesUsageResponse usage()
                               throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException