Package org.opensearch.client.opensearch.cat

Class OpenSearchCatClient

java.lang.Object

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

org.opensearch.client.opensearch.cat.OpenSearchCatClient

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

OpenSearchCatClient

public OpenSearchCatClient(OpenSearchTransport transport)

OpenSearchCatClient

public OpenSearchCatClient(OpenSearchTransport transport,
                           @Nullable
                           TransportOptions transportOptions)

Method Detail

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>

aliases

public 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 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 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 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 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 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 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 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 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 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 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 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 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 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 HealthResponse health()
                      throws java.io.IOException,
                             OpenSearchException

Returns a concise representation of the cluster health.

Throws:

java.io.IOException

OpenSearchException

help

public HelpResponse help()
                  throws java.io.IOException,
                         OpenSearchException

Returns help for the Cat APIs.

Throws:

java.io.IOException

OpenSearchException

indices

public 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 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 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 ClusterManagerResponse master()
                              throws java.io.IOException,
                                     OpenSearchException

Deprecated.

Returns information about the master node.

Throws:

java.io.IOException

OpenSearchException

clusterManager

public ClusterManagerResponse clusterManager()
                                      throws java.io.IOException,
                                             OpenSearchException

Returns information about the cluster-manager node.

Throws:

java.io.IOException

OpenSearchException

nodeattrs

public NodeattrsResponse nodeattrs()
                            throws java.io.IOException,
                                   OpenSearchException

Returns information about custom node attributes.

Throws:

java.io.IOException

OpenSearchException

nodes

public 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 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 NodesResponse nodes()
                    throws java.io.IOException,
                           OpenSearchException

Returns basic statistics about performance of cluster nodes.

Throws:

java.io.IOException

OpenSearchException

pitSegments

public SegmentsResponse pitSegments(PitSegmentsRequest request)
                             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

pitSegments

public final SegmentsResponse pitSegments(java.util.function.Function<PitSegmentsRequest.Builder,ObjectBuilder<PitSegmentsRequest>> fn)
                                   throws java.io.IOException,
                                          OpenSearchException

Provides low-level information about the disk utilization of a PIT by describing its Lucene segments. * @param fn a function that initializes a builder to create the PitSegmentsRequest

Throws:

java.io.IOException

OpenSearchException

pitSegments

public 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 PendingTasksResponse pendingTasks()
                                  throws java.io.IOException,
                                         OpenSearchException

Returns a concise representation of the cluster pending tasks.

Throws:

java.io.IOException

OpenSearchException

plugins

public PluginsResponse plugins()
                        throws java.io.IOException,
                               OpenSearchException

Returns information about installed plugins across nodes node.

Throws:

java.io.IOException

OpenSearchException

recovery

public 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 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 RecoveryResponse recovery()
                          throws java.io.IOException,
                                 OpenSearchException

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

Throws:

java.io.IOException

OpenSearchException

repositories

public RepositoriesResponse repositories()
                                  throws java.io.IOException,
                                         OpenSearchException

Returns information about snapshot repositories registered in the cluster.

Throws:

java.io.IOException

OpenSearchException

segments

public 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 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 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 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 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 ShardsResponse shards()
                      throws java.io.IOException,
                             OpenSearchException

Provides a detailed view of shard allocation on nodes.

Throws:

java.io.IOException

OpenSearchException

snapshots

public SnapshotsResponse snapshots(SnapshotsRequest request)
                            throws java.io.IOException,
                                   OpenSearchException

Returns all snapshots in a specific repository.

Throws:

java.io.IOException

OpenSearchException

snapshots

public final 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 SnapshotsResponse snapshots()
                            throws java.io.IOException,
                                   OpenSearchException

Returns all snapshots in a specific repository.

Throws:

java.io.IOException

OpenSearchException

tasks

public 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 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 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 TemplatesResponse templates(TemplatesRequest request)
                            throws java.io.IOException,
                                   OpenSearchException

Returns information about existing templates.

Throws:

java.io.IOException

OpenSearchException

templates

public final 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 TemplatesResponse templates()
                            throws java.io.IOException,
                                   OpenSearchException

Returns information about existing templates.

Throws:

java.io.IOException

OpenSearchException

threadPool

public 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 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 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