Package org.opensearch.client.opensearch.cat

Class OpenSearchCatAsyncClient

java.lang.Object

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

org.opensearch.client.opensearch.cat.OpenSearchCatAsyncClientBase<OpenSearchCatAsyncClient>

org.opensearch.client.opensearch.cat.OpenSearchCatAsyncClient

public class OpenSearchCatAsyncClient
extends OpenSearchCatAsyncClientBase<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
CompletableFuture<HelpResponse>	help()	Returns help for the Cat APIs.
OpenSearchCatAsyncClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class org.opensearch.client.opensearch.cat.OpenSearchCatAsyncClientBase

aliases, aliases, aliases, allocation, allocation, allocation, allPitSegments, allPitSegments, allPitSegments, clusterManager, clusterManager, clusterManager, count, count, count, fielddata, fielddata, fielddata, health, health, health, indices, indices, indices, master, master, master, nodeattrs, nodeattrs, nodeattrs, nodes, nodes, nodes, pendingTasks, pendingTasks, pendingTasks, pitSegments, pitSegments, plugins, plugins, plugins, recovery, recovery, recovery, repositories, repositories, repositories, segmentReplication, segmentReplication, segmentReplication, segments, segments, segments, shards, shards, shards, snapshots, snapshots, snapshots, tasks, tasks, tasks, templates, templates, templates, threadPool, threadPool, threadPool

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 Details

OpenSearchCatAsyncClient

public OpenSearchCatAsyncClient(OpenSearchTransport transport)

OpenSearchCatAsyncClient

public OpenSearchCatAsyncClient(OpenSearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

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>

help

public CompletableFuture<HelpResponse> help()
                                     throws IOException,
OpenSearchException

Returns help for the Cat APIs.

Throws:

IOException

OpenSearchException