Package org.opensearch.client.opensearch.cat

Class OpenSearchCatAsyncClient

java.lang.Object

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

org.opensearch.client.opensearch.cat.OpenSearchCatAsyncClient

public class OpenSearchCatAsyncClient
extends ApiClient<OpenSearchTransport,OpenSearchCatAsyncClient>

Client for the cat namespace.

Field Summary

Fields inherited from class org.opensearch.client.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
java.util.concurrent.CompletableFuture<AliasesResponse>	aliases()	Shows information about currently configured aliases to indices including filter and routing infos.
java.util.concurrent.CompletableFuture<AliasesResponse>	aliases(java.util.function.Function<AliasesRequest.Builder,ObjectBuilder<AliasesRequest>> fn)	Shows information about currently configured aliases to indices including filter and routing infos.
java.util.concurrent.CompletableFuture<AliasesResponse>	aliases(AliasesRequest request)	Shows information about currently configured aliases to indices including filter and routing infos.
java.util.concurrent.CompletableFuture<AllocationResponse>	allocation()	Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.
java.util.concurrent.CompletableFuture<AllocationResponse>	allocation(java.util.function.Function<AllocationRequest.Builder,ObjectBuilder<AllocationRequest>> fn)	Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.
java.util.concurrent.CompletableFuture<AllocationResponse>	allocation(AllocationRequest request)	Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.
java.util.concurrent.CompletableFuture<ClusterManagerResponse>	clusterManager()	Returns information about the cluster-manager node.
java.util.concurrent.CompletableFuture<CountResponse>	count()	Provides quick access to the document count of the entire cluster, or individual indices.
java.util.concurrent.CompletableFuture<CountResponse>	count(java.util.function.Function<CountRequest.Builder,ObjectBuilder<CountRequest>> fn)	Provides quick access to the document count of the entire cluster, or individual indices.
java.util.concurrent.CompletableFuture<CountResponse>	count(CountRequest request)	Provides quick access to the document count of the entire cluster, or individual indices.
java.util.concurrent.CompletableFuture<FielddataResponse>	fielddata()	Shows how much heap memory is currently being used by fielddata on every data node in the cluster.
java.util.concurrent.CompletableFuture<FielddataResponse>	fielddata(java.util.function.Function<FielddataRequest.Builder,ObjectBuilder<FielddataRequest>> fn)	Shows how much heap memory is currently being used by fielddata on every data node in the cluster.
java.util.concurrent.CompletableFuture<FielddataResponse>	fielddata(FielddataRequest request)	Shows how much heap memory is currently being used by fielddata on every data node in the cluster.
java.util.concurrent.CompletableFuture<HealthResponse>	health()	Returns a concise representation of the cluster health.
java.util.concurrent.CompletableFuture<HealthResponse>	health(java.util.function.Function<HealthRequest.Builder,ObjectBuilder<HealthRequest>> fn)	Returns a concise representation of the cluster health.
java.util.concurrent.CompletableFuture<HealthResponse>	health(HealthRequest request)	Returns a concise representation of the cluster health.
java.util.concurrent.CompletableFuture<HelpResponse>	help()	Returns help for the Cat APIs.
java.util.concurrent.CompletableFuture<IndicesResponse>	indices()	Returns information about indices: number of primaries and replicas, document counts, disk size, ...
java.util.concurrent.CompletableFuture<IndicesResponse>	indices(java.util.function.Function<IndicesRequest.Builder,ObjectBuilder<IndicesRequest>> fn)	Returns information about indices: number of primaries and replicas, document counts, disk size, ...
java.util.concurrent.CompletableFuture<IndicesResponse>	indices(IndicesRequest request)	Returns information about indices: number of primaries and replicas, document counts, disk size, ...
java.util.concurrent.CompletableFuture<ClusterManagerResponse>	master()	Deprecated.
java.util.concurrent.CompletableFuture<NodeattrsResponse>	nodeattrs()	Returns information about custom node attributes.
java.util.concurrent.CompletableFuture<NodesResponse>	nodes()	Returns basic statistics about performance of cluster nodes.
java.util.concurrent.CompletableFuture<NodesResponse>	nodes(java.util.function.Function<NodesRequest.Builder,ObjectBuilder<NodesRequest>> fn)	Returns basic statistics about performance of cluster nodes.
java.util.concurrent.CompletableFuture<NodesResponse>	nodes(NodesRequest request)	Returns basic statistics about performance of cluster nodes.
java.util.concurrent.CompletableFuture<PendingTasksResponse>	pendingTasks()	Returns a concise representation of the cluster pending tasks.
java.util.concurrent.CompletableFuture<SegmentsResponse>	pitSegments()	Provides low-level information about the disk utilization of a PIT by describing its Lucene segments.
java.util.concurrent.CompletableFuture<PluginsResponse>	plugins()	Returns information about installed plugins across nodes node.
java.util.concurrent.CompletableFuture<RecoveryResponse>	recovery()	Returns information about index shard recoveries, both on-going completed.
java.util.concurrent.CompletableFuture<RecoveryResponse>	recovery(java.util.function.Function<RecoveryRequest.Builder,ObjectBuilder<RecoveryRequest>> fn)	Returns information about index shard recoveries, both on-going completed.
java.util.concurrent.CompletableFuture<RecoveryResponse>	recovery(RecoveryRequest request)	Returns information about index shard recoveries, both on-going completed.
java.util.concurrent.CompletableFuture<RepositoriesResponse>	repositories()	Returns information about snapshot repositories registered in the cluster.
java.util.concurrent.CompletableFuture<SegmentsResponse>	segments()	Provides low-level information about the segments in the shards of an index.
java.util.concurrent.CompletableFuture<SegmentsResponse>	segments(java.util.function.Function<SegmentsRequest.Builder,ObjectBuilder<SegmentsRequest>> fn)	Provides low-level information about the segments in the shards of an index.
java.util.concurrent.CompletableFuture<SegmentsResponse>	segments(SegmentsRequest request)	Provides low-level information about the segments in the shards of an index.
java.util.concurrent.CompletableFuture<ShardsResponse>	shards()	Provides a detailed view of shard allocation on nodes.
java.util.concurrent.CompletableFuture<ShardsResponse>	shards(java.util.function.Function<ShardsRequest.Builder,ObjectBuilder<ShardsRequest>> fn)	Provides a detailed view of shard allocation on nodes.
java.util.concurrent.CompletableFuture<ShardsResponse>	shards(ShardsRequest request)	Provides a detailed view of shard allocation on nodes.
java.util.concurrent.CompletableFuture<SnapshotsResponse>	snapshots()	Returns all snapshots in a specific repository.
java.util.concurrent.CompletableFuture<SnapshotsResponse>	snapshots(java.util.function.Function<SnapshotsRequest.Builder,ObjectBuilder<SnapshotsRequest>> fn)	Returns all snapshots in a specific repository.
java.util.concurrent.CompletableFuture<SnapshotsResponse>	snapshots(SnapshotsRequest request)	Returns all snapshots in a specific repository.
java.util.concurrent.CompletableFuture<TasksResponse>	tasks()	Returns information about the tasks currently executing on one or more nodes in the cluster.
java.util.concurrent.CompletableFuture<TasksResponse>	tasks(java.util.function.Function<TasksRequest.Builder,ObjectBuilder<TasksRequest>> fn)	Returns information about the tasks currently executing on one or more nodes in the cluster.
java.util.concurrent.CompletableFuture<TasksResponse>	tasks(TasksRequest request)	Returns information about the tasks currently executing on one or more nodes in the cluster.
java.util.concurrent.CompletableFuture<TemplatesResponse>	templates()	Returns information about existing templates.
java.util.concurrent.CompletableFuture<TemplatesResponse>	templates(java.util.function.Function<TemplatesRequest.Builder,ObjectBuilder<TemplatesRequest>> fn)	Returns information about existing templates.
java.util.concurrent.CompletableFuture<TemplatesResponse>	templates(TemplatesRequest request)	Returns information about existing templates.
java.util.concurrent.CompletableFuture<ThreadPoolResponse>	threadPool()	Returns cluster-wide thread pool statistics per node.
java.util.concurrent.CompletableFuture<ThreadPoolResponse>	threadPool(java.util.function.Function<ThreadPoolRequest.Builder,ObjectBuilder<ThreadPoolRequest>> fn)	Returns cluster-wide thread pool statistics per node.
java.util.concurrent.CompletableFuture<ThreadPoolResponse>	threadPool(ThreadPoolRequest request)	Returns cluster-wide thread pool statistics per node.
OpenSearchCatAsyncClient	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

OpenSearchCatAsyncClient

public OpenSearchCatAsyncClient(OpenSearchTransport transport)

OpenSearchCatAsyncClient

public OpenSearchCatAsyncClient(OpenSearchTransport transport,
                                @Nullable
                                TransportOptions transportOptions)

Method Detail

withTransportOptions

public OpenSearchCatAsyncClient withTransportOptions(@Nullable
                                                     TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<OpenSearchTransport,OpenSearchCatAsyncClient>

aliases

public java.util.concurrent.CompletableFuture<AliasesResponse> aliases(AliasesRequest request)
                                                                throws java.io.IOException,
                                                                       OpenSearchException

Shows information about currently configured aliases to indices including filter and routing infos.

Throws:

java.io.IOException

OpenSearchException

aliases

public final java.util.concurrent.CompletableFuture<AliasesResponse> aliases(java.util.function.Function<AliasesRequest.Builder,ObjectBuilder<AliasesRequest>> fn)
                                                                      throws java.io.IOException,
                                                                             OpenSearchException

Shows information about currently configured aliases to indices including filter and routing infos.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

aliases

public java.util.concurrent.CompletableFuture<AliasesResponse> aliases()
                                                                throws java.io.IOException,
                                                                       OpenSearchException

Shows information about currently configured aliases to indices including filter and routing infos.

Throws:

java.io.IOException

OpenSearchException

allocation

public java.util.concurrent.CompletableFuture<AllocationResponse> allocation(AllocationRequest request)
                                                                      throws java.io.IOException,
                                                                             OpenSearchException

Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.

Throws:

java.io.IOException

OpenSearchException

allocation

public final java.util.concurrent.CompletableFuture<AllocationResponse> allocation(java.util.function.Function<AllocationRequest.Builder,ObjectBuilder<AllocationRequest>> fn)
                                                                            throws java.io.IOException,
                                                                                   OpenSearchException

Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

allocation

public java.util.concurrent.CompletableFuture<AllocationResponse> allocation()
                                                                      throws java.io.IOException,
                                                                             OpenSearchException

Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.

Throws:

java.io.IOException

OpenSearchException

count

public java.util.concurrent.CompletableFuture<CountResponse> count(CountRequest request)
                                                            throws java.io.IOException,
                                                                   OpenSearchException

Provides quick access to the document count of the entire cluster, or individual indices.

Throws:

java.io.IOException

OpenSearchException

count

public final java.util.concurrent.CompletableFuture<CountResponse> count(java.util.function.Function<CountRequest.Builder,ObjectBuilder<CountRequest>> fn)
                                                                  throws java.io.IOException,
                                                                         OpenSearchException

Provides quick access to the document count of the entire cluster, or individual indices.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

count

public java.util.concurrent.CompletableFuture<CountResponse> count()
                                                            throws java.io.IOException,
                                                                   OpenSearchException

Provides quick access to the document count of the entire cluster, or individual indices.

Throws:

java.io.IOException

OpenSearchException

fielddata

public java.util.concurrent.CompletableFuture<FielddataResponse> fielddata(FielddataRequest request)
                                                                    throws java.io.IOException,
                                                                           OpenSearchException

Shows how much heap memory is currently being used by fielddata on every data node in the cluster.

Throws:

java.io.IOException

OpenSearchException

fielddata

public final java.util.concurrent.CompletableFuture<FielddataResponse> fielddata(java.util.function.Function<FielddataRequest.Builder,ObjectBuilder<FielddataRequest>> fn)
                                                                          throws java.io.IOException,
                                                                                 OpenSearchException

Shows how much heap memory is currently being used by fielddata on every data node in the cluster.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

fielddata

public java.util.concurrent.CompletableFuture<FielddataResponse> fielddata()
                                                                    throws java.io.IOException,
                                                                           OpenSearchException

Shows how much heap memory is currently being used by fielddata on every data node in the cluster.

Throws:

java.io.IOException

OpenSearchException

health

public java.util.concurrent.CompletableFuture<HealthResponse> health(HealthRequest request)
                                                              throws java.io.IOException,
                                                                     OpenSearchException

Returns a concise representation of the cluster health.

Throws:

java.io.IOException

OpenSearchException

health

public final java.util.concurrent.CompletableFuture<HealthResponse> health(java.util.function.Function<HealthRequest.Builder,ObjectBuilder<HealthRequest>> fn)
                                                                    throws java.io.IOException,
                                                                           OpenSearchException

Returns a concise representation of the cluster health.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

health

public java.util.concurrent.CompletableFuture<HealthResponse> health()
                                                              throws java.io.IOException,
                                                                     OpenSearchException

Returns a concise representation of the cluster health.

Throws:

java.io.IOException

OpenSearchException

help

public java.util.concurrent.CompletableFuture<HelpResponse> help()
                                                          throws java.io.IOException,
                                                                 OpenSearchException

Returns help for the Cat APIs.

Throws:

java.io.IOException

OpenSearchException

indices

public java.util.concurrent.CompletableFuture<IndicesResponse> indices(IndicesRequest request)
                                                                throws java.io.IOException,
                                                                       OpenSearchException

Returns information about indices: number of primaries and replicas, document counts, disk size, ...

Throws:

java.io.IOException

OpenSearchException

indices

public final java.util.concurrent.CompletableFuture<IndicesResponse> indices(java.util.function.Function<IndicesRequest.Builder,ObjectBuilder<IndicesRequest>> fn)
                                                                      throws java.io.IOException,
                                                                             OpenSearchException

Returns information about indices: number of primaries and replicas, document counts, disk size, ...

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

indices

public java.util.concurrent.CompletableFuture<IndicesResponse> indices()
                                                                throws java.io.IOException,
                                                                       OpenSearchException

Returns information about indices: number of primaries and replicas, document counts, disk size, ...

Throws:

java.io.IOException

OpenSearchException

master

@Deprecated
public java.util.concurrent.CompletableFuture<ClusterManagerResponse> master()
                                                                      throws java.io.IOException,
                                                                             OpenSearchException

Deprecated.

Returns information about the master node.

Throws:

java.io.IOException

OpenSearchException

clusterManager

public java.util.concurrent.CompletableFuture<ClusterManagerResponse> clusterManager()
                                                                              throws java.io.IOException,
                                                                                     OpenSearchException

Returns information about the cluster-manager node.

Throws:

java.io.IOException

OpenSearchException

nodeattrs

public java.util.concurrent.CompletableFuture<NodeattrsResponse> nodeattrs()
                                                                    throws java.io.IOException,
                                                                           OpenSearchException

Returns information about custom node attributes.

Throws:

java.io.IOException

OpenSearchException

nodes

public java.util.concurrent.CompletableFuture<NodesResponse> nodes(NodesRequest request)
                                                            throws java.io.IOException,
                                                                   OpenSearchException

Returns basic statistics about performance of cluster nodes.

Throws:

java.io.IOException

OpenSearchException

nodes

public final java.util.concurrent.CompletableFuture<NodesResponse> nodes(java.util.function.Function<NodesRequest.Builder,ObjectBuilder<NodesRequest>> fn)
                                                                  throws java.io.IOException,
                                                                         OpenSearchException

Returns basic statistics about performance of cluster nodes.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

nodes

public java.util.concurrent.CompletableFuture<NodesResponse> nodes()
                                                            throws java.io.IOException,
                                                                   OpenSearchException

Returns basic statistics about performance of cluster nodes.

Throws:

java.io.IOException

OpenSearchException

pitSegments

public java.util.concurrent.CompletableFuture<SegmentsResponse> pitSegments()
                                                                     throws java.io.IOException,
                                                                            OpenSearchException

Provides low-level information about the disk utilization of a PIT by describing its Lucene segments.

Throws:

java.io.IOException

OpenSearchException

pendingTasks

public java.util.concurrent.CompletableFuture<PendingTasksResponse> pendingTasks()
                                                                          throws java.io.IOException,
                                                                                 OpenSearchException

Returns a concise representation of the cluster pending tasks.

Throws:

java.io.IOException

OpenSearchException

plugins

public java.util.concurrent.CompletableFuture<PluginsResponse> plugins()
                                                                throws java.io.IOException,
                                                                       OpenSearchException

Returns information about installed plugins across nodes node.

Throws:

java.io.IOException

OpenSearchException

recovery

public java.util.concurrent.CompletableFuture<RecoveryResponse> recovery(RecoveryRequest request)
                                                                  throws java.io.IOException,
                                                                         OpenSearchException

Returns information about index shard recoveries, both on-going completed.

Throws:

java.io.IOException

OpenSearchException

recovery

public final java.util.concurrent.CompletableFuture<RecoveryResponse> recovery(java.util.function.Function<RecoveryRequest.Builder,ObjectBuilder<RecoveryRequest>> fn)
                                                                        throws java.io.IOException,
                                                                               OpenSearchException

Returns information about index shard recoveries, both on-going completed.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

recovery

public java.util.concurrent.CompletableFuture<RecoveryResponse> recovery()
                                                                  throws java.io.IOException,
                                                                         OpenSearchException

Returns information about index shard recoveries, both on-going completed.

Throws:

java.io.IOException

OpenSearchException

repositories

public java.util.concurrent.CompletableFuture<RepositoriesResponse> repositories()
                                                                          throws java.io.IOException,
                                                                                 OpenSearchException

Returns information about snapshot repositories registered in the cluster.

Throws:

java.io.IOException

OpenSearchException

segments

public java.util.concurrent.CompletableFuture<SegmentsResponse> segments(SegmentsRequest request)
                                                                  throws java.io.IOException,
                                                                         OpenSearchException

Provides low-level information about the segments in the shards of an index.

Throws:

java.io.IOException

OpenSearchException

segments

public final java.util.concurrent.CompletableFuture<SegmentsResponse> segments(java.util.function.Function<SegmentsRequest.Builder,ObjectBuilder<SegmentsRequest>> fn)
                                                                        throws java.io.IOException,
                                                                               OpenSearchException

Provides low-level information about the segments in the shards of an index.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

segments

public java.util.concurrent.CompletableFuture<SegmentsResponse> segments()
                                                                  throws java.io.IOException,
                                                                         OpenSearchException

Provides low-level information about the segments in the shards of an index.

Throws:

java.io.IOException

OpenSearchException

shards

public java.util.concurrent.CompletableFuture<ShardsResponse> shards(ShardsRequest request)
                                                              throws java.io.IOException,
                                                                     OpenSearchException

Provides a detailed view of shard allocation on nodes.

Throws:

java.io.IOException

OpenSearchException

shards

public final java.util.concurrent.CompletableFuture<ShardsResponse> shards(java.util.function.Function<ShardsRequest.Builder,ObjectBuilder<ShardsRequest>> fn)
                                                                    throws java.io.IOException,
                                                                           OpenSearchException

Provides a detailed view of shard allocation on nodes.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

shards

public java.util.concurrent.CompletableFuture<ShardsResponse> shards()
                                                              throws java.io.IOException,
                                                                     OpenSearchException

Provides a detailed view of shard allocation on nodes.

Throws:

java.io.IOException

OpenSearchException

snapshots

public java.util.concurrent.CompletableFuture<SnapshotsResponse> snapshots(SnapshotsRequest request)
                                                                    throws java.io.IOException,
                                                                           OpenSearchException

Returns all snapshots in a specific repository.

Throws:

java.io.IOException

OpenSearchException

snapshots

public final java.util.concurrent.CompletableFuture<SnapshotsResponse> snapshots(java.util.function.Function<SnapshotsRequest.Builder,ObjectBuilder<SnapshotsRequest>> fn)
                                                                          throws java.io.IOException,
                                                                                 OpenSearchException

Returns all snapshots in a specific repository.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

snapshots

public java.util.concurrent.CompletableFuture<SnapshotsResponse> snapshots()
                                                                    throws java.io.IOException,
                                                                           OpenSearchException

Returns all snapshots in a specific repository.

Throws:

java.io.IOException

OpenSearchException

tasks

public java.util.concurrent.CompletableFuture<TasksResponse> tasks(TasksRequest request)
                                                            throws java.io.IOException,
                                                                   OpenSearchException

Returns information about the tasks currently executing on one or more nodes in the cluster.

Throws:

java.io.IOException

OpenSearchException

tasks

public final java.util.concurrent.CompletableFuture<TasksResponse> tasks(java.util.function.Function<TasksRequest.Builder,ObjectBuilder<TasksRequest>> fn)
                                                                  throws java.io.IOException,
                                                                         OpenSearchException

Returns information about the tasks currently executing on one or more nodes in the cluster.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

tasks

public java.util.concurrent.CompletableFuture<TasksResponse> tasks()
                                                            throws java.io.IOException,
                                                                   OpenSearchException

Returns information about the tasks currently executing on one or more nodes in the cluster.

Throws:

java.io.IOException

OpenSearchException

templates

public java.util.concurrent.CompletableFuture<TemplatesResponse> templates(TemplatesRequest request)
                                                                    throws java.io.IOException,
                                                                           OpenSearchException

Returns information about existing templates.

Throws:

java.io.IOException

OpenSearchException

templates

public final java.util.concurrent.CompletableFuture<TemplatesResponse> templates(java.util.function.Function<TemplatesRequest.Builder,ObjectBuilder<TemplatesRequest>> fn)
                                                                          throws java.io.IOException,
                                                                                 OpenSearchException

Returns information about existing templates.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

templates

public java.util.concurrent.CompletableFuture<TemplatesResponse> templates()
                                                                    throws java.io.IOException,
                                                                           OpenSearchException

Returns information about existing templates.

Throws:

java.io.IOException

OpenSearchException

threadPool

public java.util.concurrent.CompletableFuture<ThreadPoolResponse> threadPool(ThreadPoolRequest request)
                                                                      throws java.io.IOException,
                                                                             OpenSearchException

Returns cluster-wide thread pool statistics per node. By default the active, queue and rejected statistics are returned for all thread pools.

Throws:

java.io.IOException

OpenSearchException

threadPool

public final java.util.concurrent.CompletableFuture<ThreadPoolResponse> threadPool(java.util.function.Function<ThreadPoolRequest.Builder,ObjectBuilder<ThreadPoolRequest>> fn)
                                                                            throws java.io.IOException,
                                                                                   OpenSearchException

Returns cluster-wide thread pool statistics per node. By default the active, queue and rejected statistics are returned for all thread pools.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

threadPool

public java.util.concurrent.CompletableFuture<ThreadPoolResponse> threadPool()
                                                                      throws java.io.IOException,
                                                                             OpenSearchException

Returns cluster-wide thread pool statistics per node. By default the active, queue and rejected statistics are returned for all thread pools.

Throws:

java.io.IOException

OpenSearchException