Package co.elastic.clients.elasticsearch.nodes

Class ElasticsearchNodesClient

java.lang.Object

co.elastic.clients.ApiClient<ElasticsearchTransport,ElasticsearchNodesClient>

co.elastic.clients.elasticsearch.nodes.ElasticsearchNodesClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class ElasticsearchNodesClient
extends ApiClient<ElasticsearchTransport,ElasticsearchNodesClient>

Client for the nodes namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
ElasticsearchNodesClient(ElasticsearchTransport transport)
ElasticsearchNodesClient(ElasticsearchTransport transport, TransportOptions transportOptions)

Method Summary

Modifier and Type	Method	Description
ClearRepositoriesMeteringArchiveResponse	clearRepositoriesMeteringArchive(ClearRepositoriesMeteringArchiveRequest request)	Clear the archived repositories metering.
final ClearRepositoriesMeteringArchiveResponse	clearRepositoriesMeteringArchive(Function<ClearRepositoriesMeteringArchiveRequest.Builder,ObjectBuilder<ClearRepositoriesMeteringArchiveRequest>> fn)	Clear the archived repositories metering.
GetRepositoriesMeteringInfoResponse	getRepositoriesMeteringInfo(GetRepositoriesMeteringInfoRequest request)	Get cluster repositories metering.
final GetRepositoriesMeteringInfoResponse	getRepositoriesMeteringInfo(Function<GetRepositoriesMeteringInfoRequest.Builder,ObjectBuilder<GetRepositoriesMeteringInfoRequest>> fn)	Get cluster repositories metering.
HotThreadsResponse	hotThreads()	Get the hot threads for nodes.
HotThreadsResponse	hotThreads(HotThreadsRequest request)	Get the hot threads for nodes.
final HotThreadsResponse	hotThreads(Function<HotThreadsRequest.Builder,ObjectBuilder<HotThreadsRequest>> fn)	Get the hot threads for nodes.
NodesInfoResponse	info()	Get node information.
NodesInfoResponse	info(NodesInfoRequest request)	Get node information.
final NodesInfoResponse	info(Function<NodesInfoRequest.Builder,ObjectBuilder<NodesInfoRequest>> fn)	Get node information.
ReloadSecureSettingsResponse	reloadSecureSettings()	Reload the keystore on nodes in the cluster.
ReloadSecureSettingsResponse	reloadSecureSettings(ReloadSecureSettingsRequest request)	Reload the keystore on nodes in the cluster.
final ReloadSecureSettingsResponse	reloadSecureSettings(Function<ReloadSecureSettingsRequest.Builder,ObjectBuilder<ReloadSecureSettingsRequest>> fn)	Reload the keystore on nodes in the cluster.
NodesStatsResponse	stats()	Get node statistics.
NodesStatsResponse	stats(NodesStatsRequest request)	Get node statistics.
final NodesStatsResponse	stats(Function<NodesStatsRequest.Builder,ObjectBuilder<NodesStatsRequest>> fn)	Get node statistics.
NodesUsageResponse	usage()	Get feature usage information.
NodesUsageResponse	usage(NodesUsageRequest request)	Get feature usage information.
final NodesUsageResponse	usage(Function<NodesUsageRequest.Builder,ObjectBuilder<NodesUsageRequest>> fn)	Get feature usage information.
ElasticsearchNodesClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class co.elastic.clients.ApiClient

_jsonpMapper, _transport, _transportOptions, close, getDeserializer, withTransportOptions

Methods inherited from class java.lang.Object

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

Constructor Details

ElasticsearchNodesClient

public ElasticsearchNodesClient(ElasticsearchTransport transport)

ElasticsearchNodesClient

public ElasticsearchNodesClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchNodesClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchNodesClient>

clearRepositoriesMeteringArchive

public ClearRepositoriesMeteringArchiveResponse clearRepositoriesMeteringArchive(ClearRepositoriesMeteringArchiveRequest request)
                                                                          throws IOException,
ElasticsearchException

Clear the archived repositories metering. Clear the archived repositories metering information in the cluster.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

clearRepositoriesMeteringArchive

public final ClearRepositoriesMeteringArchiveResponse clearRepositoriesMeteringArchive(Function<ClearRepositoriesMeteringArchiveRequest.Builder,ObjectBuilder<ClearRepositoriesMeteringArchiveRequest>> fn)
                                                                                throws IOException,
ElasticsearchException

Clear the archived repositories metering. Clear the archived repositories metering information in the cluster.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getRepositoriesMeteringInfo

public GetRepositoriesMeteringInfoResponse getRepositoriesMeteringInfo(GetRepositoriesMeteringInfoRequest request)
                                                                throws IOException,
ElasticsearchException

Get cluster repositories metering. Get repositories metering information for a cluster. This API exposes monotonically non-decreasing counters and it is expected that clients would durably store the information needed to compute aggregations over a period of time. Additionally, the information exposed by this API is volatile, meaning that it will not be present after node restarts.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getRepositoriesMeteringInfo

public final GetRepositoriesMeteringInfoResponse getRepositoriesMeteringInfo(Function<GetRepositoriesMeteringInfoRequest.Builder,ObjectBuilder<GetRepositoriesMeteringInfoRequest>> fn)
                                                                      throws IOException,
ElasticsearchException

Get cluster repositories metering. Get repositories metering information for a cluster. This API exposes monotonically non-decreasing counters and it is expected that clients would durably store the information needed to compute aggregations over a period of time. Additionally, the information exposed by this API is volatile, meaning that it will not be present after node restarts.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

hotThreads

public HotThreadsResponse hotThreads(HotThreadsRequest request)
                              throws IOException,
ElasticsearchException

Get the hot threads for nodes. Get a breakdown of the hot threads on each selected node in the cluster. The output is plain text with a breakdown of the top hot threads for each node.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

hotThreads

public final HotThreadsResponse hotThreads(Function<HotThreadsRequest.Builder,ObjectBuilder<HotThreadsRequest>> fn)
                                    throws IOException,
ElasticsearchException

Get the hot threads for nodes. Get a breakdown of the hot threads on each selected node in the cluster. The output is plain text with a breakdown of the top hot threads for each node.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

hotThreads

public HotThreadsResponse hotThreads()
                              throws IOException,
ElasticsearchException

Get the hot threads for nodes. Get a breakdown of the hot threads on each selected node in the cluster. The output is plain text with a breakdown of the top hot threads for each node.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

info

public NodesInfoResponse info(NodesInfoRequest request)
                       throws IOException,
ElasticsearchException

Get node information.

By default, the API returns all attributes and core settings for cluster nodes.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

info

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

Get node information.

By default, the API returns all attributes and core settings for cluster nodes.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

info

public NodesInfoResponse info()
                       throws IOException,
ElasticsearchException

Get node information.

By default, the API returns all attributes and core settings for cluster nodes.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

reloadSecureSettings

public ReloadSecureSettingsResponse reloadSecureSettings(ReloadSecureSettingsRequest request)
                                                  throws IOException,
ElasticsearchException

Reload the keystore on nodes in the cluster.

Secure settings are stored in an on-disk keystore. Certain of these settings are reloadable. That is, you can change them on disk and reload them without restarting any nodes in the cluster. When you have updated reloadable secure settings in your keystore, you can use this API to reload those settings on each node.

When the Elasticsearch keystore is password protected and not simply obfuscated, you must provide the password for the keystore when you reload the secure settings. Reloading the settings for the whole cluster assumes that the keystores for all nodes are protected with the same password; this method is allowed only when inter-node communications are encrypted. Alternatively, you can reload the secure settings on each node by locally accessing the API and passing the node-specific Elasticsearch keystore password.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

reloadSecureSettings

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

Reload the keystore on nodes in the cluster.

Secure settings are stored in an on-disk keystore. Certain of these settings are reloadable. That is, you can change them on disk and reload them without restarting any nodes in the cluster. When you have updated reloadable secure settings in your keystore, you can use this API to reload those settings on each node.

When the Elasticsearch keystore is password protected and not simply obfuscated, you must provide the password for the keystore when you reload the secure settings. Reloading the settings for the whole cluster assumes that the keystores for all nodes are protected with the same password; this method is allowed only when inter-node communications are encrypted. Alternatively, you can reload the secure settings on each node by locally accessing the API and passing the node-specific Elasticsearch keystore password.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

reloadSecureSettings

public ReloadSecureSettingsResponse reloadSecureSettings()
                                                  throws IOException,
ElasticsearchException

Reload the keystore on nodes in the cluster.

Secure settings are stored in an on-disk keystore. Certain of these settings are reloadable. That is, you can change them on disk and reload them without restarting any nodes in the cluster. When you have updated reloadable secure settings in your keystore, you can use this API to reload those settings on each node.

When the Elasticsearch keystore is password protected and not simply obfuscated, you must provide the password for the keystore when you reload the secure settings. Reloading the settings for the whole cluster assumes that the keystores for all nodes are protected with the same password; this method is allowed only when inter-node communications are encrypted. Alternatively, you can reload the secure settings on each node by locally accessing the API and passing the node-specific Elasticsearch keystore password.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stats

public NodesStatsResponse stats(NodesStatsRequest request)
                         throws IOException,
ElasticsearchException

Get node statistics. Get statistics for nodes in a cluster. By default, all stats are returned. You can limit the returned information by using metrics.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stats

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

Get node statistics. Get statistics for nodes in a cluster. By default, all stats are returned. You can limit the returned information by using metrics.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stats

public NodesStatsResponse stats()
                         throws IOException,
ElasticsearchException

Get node statistics. Get statistics for nodes in a cluster. By default, all stats are returned. You can limit the returned information by using metrics.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

usage

public NodesUsageResponse usage(NodesUsageRequest request)
                         throws IOException,
ElasticsearchException

Get feature usage information.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

usage

public final NodesUsageResponse usage(Function<NodesUsageRequest.Builder,ObjectBuilder<NodesUsageRequest>> fn)
                               throws IOException,
ElasticsearchException

Get feature usage information.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

usage

public NodesUsageResponse usage()
                         throws IOException,
ElasticsearchException

Get feature usage information.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co