Package org.opensearch.client.opensearch.cat

Class OpenSearchCatClient

java.lang.Object

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

org.opensearch.client.opensearch.cat.OpenSearchCatClientBase<OpenSearchCatClient>

org.opensearch.client.opensearch.cat.OpenSearchCatClient

public class OpenSearchCatClient
extends OpenSearchCatClientBase<OpenSearchCatClient>

Client for the cat namespace.

Field Summary

Fields inherited from class org.opensearch.client.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
HelpResponse	help()	Returns help for the Cat APIs.
OpenSearchCatClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

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

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

OpenSearchCatClient

public OpenSearchCatClient(OpenSearchTransport transport)

OpenSearchCatClient

public OpenSearchCatClient(OpenSearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public OpenSearchCatClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<OpenSearchTransport,OpenSearchCatClient>

help

public HelpResponse help()
                  throws IOException,
OpenSearchException

Returns help for the Cat APIs.

Throws:

IOException

OpenSearchException