Package co.elastic.clients.elasticsearch.cat

Class ElasticsearchCatClient

java.lang.Object

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

co.elastic.clients.elasticsearch.cat.ElasticsearchCatClient

public class ElasticsearchCatClient
extends ApiClient<ElasticsearchTransport,ElasticsearchCatClient>

Client for the cat namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
AliasesResponse	aliases()	Retrieves the cluster’s index aliases, including filter and routing information.
AliasesResponse	aliases(AliasesRequest request)	Retrieves the cluster’s index aliases, including filter and routing information.
final AliasesResponse	aliases(Function<AliasesRequest.Builder,ObjectBuilder<AliasesRequest>> fn)	Retrieves the cluster’s index aliases, including filter and routing information.
AllocationResponse	allocation()	Provides a snapshot of the number of shards allocated to each data node and their disk space.
AllocationResponse	allocation(AllocationRequest request)	Provides a snapshot of the number of shards allocated to each data node and their disk space.
final AllocationResponse	allocation(Function<AllocationRequest.Builder,ObjectBuilder<AllocationRequest>> fn)	Provides a snapshot of the number of shards allocated to each data node and their disk space.
ComponentTemplatesResponse	componentTemplates()	Returns information about component templates in a cluster.
ComponentTemplatesResponse	componentTemplates(ComponentTemplatesRequest request)	Returns information about component templates in a cluster.
final ComponentTemplatesResponse	componentTemplates(Function<ComponentTemplatesRequest.Builder,ObjectBuilder<ComponentTemplatesRequest>> fn)	Returns information about component templates in a cluster.
CountResponse	count()	Provides quick access to a document count for a data stream, an index, or an entire cluster.
CountResponse	count(CountRequest request)	Provides quick access to a document count for a data stream, an index, or an entire cluster.
final CountResponse	count(Function<CountRequest.Builder,ObjectBuilder<CountRequest>> fn)	Provides quick access to a document count for a data stream, an index, or an entire cluster.
FielddataResponse	fielddata()	Returns the amount of heap memory currently used by the field data cache on every data node in the cluster.
FielddataResponse	fielddata(FielddataRequest request)	Returns the amount of heap memory currently used by the field data cache on every data node in the cluster.
final FielddataResponse	fielddata(Function<FielddataRequest.Builder,ObjectBuilder<FielddataRequest>> fn)	Returns the amount of heap memory currently used by the field data cache on every data node in the cluster.
HealthResponse	health()	Returns the health status of a cluster, similar to the cluster health API.
HealthResponse	health(HealthRequest request)	Returns the health status of a cluster, similar to the cluster health API.
final HealthResponse	health(Function<HealthRequest.Builder,ObjectBuilder<HealthRequest>> fn)	Returns the health status of a cluster, similar to the cluster health API.
HelpResponse	help()	Returns help for the Cat APIs.
IndicesResponse	indices()	Returns high-level information about indices in a cluster, including backing indices for data streams.
IndicesResponse	indices(IndicesRequest request)	Returns high-level information about indices in a cluster, including backing indices for data streams.
final IndicesResponse	indices(Function<IndicesRequest.Builder,ObjectBuilder<IndicesRequest>> fn)	Returns high-level information about indices in a cluster, including backing indices for data streams.
MasterResponse	master()	Returns information about the master node, including the ID, bound IP address, and name.
MlDatafeedsResponse	mlDatafeeds()	Returns configuration and usage information about datafeeds.
MlDatafeedsResponse	mlDatafeeds(MlDatafeedsRequest request)	Returns configuration and usage information about datafeeds.
final MlDatafeedsResponse	mlDatafeeds(Function<MlDatafeedsRequest.Builder,ObjectBuilder<MlDatafeedsRequest>> fn)	Returns configuration and usage information about datafeeds.
MlDataFrameAnalyticsResponse	mlDataFrameAnalytics()	Returns configuration and usage information about data frame analytics jobs.
MlDataFrameAnalyticsResponse	mlDataFrameAnalytics(MlDataFrameAnalyticsRequest request)	Returns configuration and usage information about data frame analytics jobs.
final MlDataFrameAnalyticsResponse	mlDataFrameAnalytics(Function<MlDataFrameAnalyticsRequest.Builder,ObjectBuilder<MlDataFrameAnalyticsRequest>> fn)	Returns configuration and usage information about data frame analytics jobs.
MlJobsResponse	mlJobs()	Returns configuration and usage information for anomaly detection jobs.
MlJobsResponse	mlJobs(MlJobsRequest request)	Returns configuration and usage information for anomaly detection jobs.
final MlJobsResponse	mlJobs(Function<MlJobsRequest.Builder,ObjectBuilder<MlJobsRequest>> fn)	Returns configuration and usage information for anomaly detection jobs.
MlTrainedModelsResponse	mlTrainedModels()	Returns configuration and usage information about inference trained models.
MlTrainedModelsResponse	mlTrainedModels(MlTrainedModelsRequest request)	Returns configuration and usage information about inference trained models.
final MlTrainedModelsResponse	mlTrainedModels(Function<MlTrainedModelsRequest.Builder,ObjectBuilder<MlTrainedModelsRequest>> fn)	Returns configuration and usage information about inference trained models.
NodeattrsResponse	nodeattrs()	Returns information about custom node attributes.
NodesResponse	nodes()	Returns information about the nodes in a cluster.
NodesResponse	nodes(NodesRequest request)	Returns information about the nodes in a cluster.
final NodesResponse	nodes(Function<NodesRequest.Builder,ObjectBuilder<NodesRequest>> fn)	Returns information about the nodes in a cluster.
PendingTasksResponse	pendingTasks()	Returns cluster-level changes that have not yet been executed.
PluginsResponse	plugins()	Returns a list of plugins running on each node of a cluster.
RecoveryResponse	recovery()	Returns information about ongoing and completed shard recoveries.
RecoveryResponse	recovery(RecoveryRequest request)	Returns information about ongoing and completed shard recoveries.
final RecoveryResponse	recovery(Function<RecoveryRequest.Builder,ObjectBuilder<RecoveryRequest>> fn)	Returns information about ongoing and completed shard recoveries.
RepositoriesResponse	repositories()	Returns the snapshot repositories for a cluster.
SegmentsResponse	segments()	Returns low-level information about the Lucene segments in index shards.
SegmentsResponse	segments(SegmentsRequest request)	Returns low-level information about the Lucene segments in index shards.
final SegmentsResponse	segments(Function<SegmentsRequest.Builder,ObjectBuilder<SegmentsRequest>> fn)	Returns low-level information about the Lucene segments in index shards.
ShardsResponse	shards()	Returns information about the shards in a cluster.
ShardsResponse	shards(ShardsRequest request)	Returns information about the shards in a cluster.
final ShardsResponse	shards(Function<ShardsRequest.Builder,ObjectBuilder<ShardsRequest>> fn)	Returns information about the shards in a cluster.
SnapshotsResponse	snapshots()	Returns information about the snapshots stored in one or more repositories.
SnapshotsResponse	snapshots(SnapshotsRequest request)	Returns information about the snapshots stored in one or more repositories.
final SnapshotsResponse	snapshots(Function<SnapshotsRequest.Builder,ObjectBuilder<SnapshotsRequest>> fn)	Returns information about the snapshots stored in one or more repositories.
TasksResponse	tasks()	Returns information about tasks currently executing in the cluster.
TasksResponse	tasks(TasksRequest request)	Returns information about tasks currently executing in the cluster.
final TasksResponse	tasks(Function<TasksRequest.Builder,ObjectBuilder<TasksRequest>> fn)	Returns information about tasks currently executing in the cluster.
TemplatesResponse	templates()	Returns information about index templates in a cluster.
TemplatesResponse	templates(TemplatesRequest request)	Returns information about index templates in a cluster.
final TemplatesResponse	templates(Function<TemplatesRequest.Builder,ObjectBuilder<TemplatesRequest>> fn)	Returns information about index templates in a cluster.
ThreadPoolResponse	threadPool()	Returns thread pool statistics for each node in a cluster.
ThreadPoolResponse	threadPool(ThreadPoolRequest request)	Returns thread pool statistics for each node in a cluster.
final ThreadPoolResponse	threadPool(Function<ThreadPoolRequest.Builder,ObjectBuilder<ThreadPoolRequest>> fn)	Returns thread pool statistics for each node in a cluster.
TransformsResponse	transforms()	Returns configuration and usage information about transforms.
TransformsResponse	transforms(TransformsRequest request)	Returns configuration and usage information about transforms.
final TransformsResponse	transforms(Function<TransformsRequest.Builder,ObjectBuilder<TransformsRequest>> fn)	Returns configuration and usage information about transforms.
ElasticsearchCatClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class co.elastic.clients.ApiClient

_jsonpMapper, _transport, _transportOptions, getDeserializer, withTransportOptions

Methods inherited from class java.lang.Object

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

Constructor Details

ElasticsearchCatClient

public ElasticsearchCatClient(ElasticsearchTransport transport)

ElasticsearchCatClient

public ElasticsearchCatClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchCatClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchCatClient>

aliases

public AliasesResponse aliases(AliasesRequest request)
                        throws IOException,
ElasticsearchException

Retrieves the cluster’s index aliases, including filter and routing information. The API does not return data stream aliases. IMPORTANT: cat APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

aliases

public final AliasesResponse aliases(Function<AliasesRequest.Builder,ObjectBuilder<AliasesRequest>> fn)
                              throws IOException,
ElasticsearchException

Retrieves the cluster’s index aliases, including filter and routing information. The API does not return data stream aliases. IMPORTANT: cat APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

aliases

public AliasesResponse aliases()
                        throws IOException,
ElasticsearchException

Retrieves the cluster’s index aliases, including filter and routing information. The API does not return data stream aliases. IMPORTANT: cat APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

allocation

public AllocationResponse allocation(AllocationRequest request)
                              throws IOException,
ElasticsearchException

Provides a snapshot of the number of shards allocated to each data node and their disk space. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

allocation

public final AllocationResponse allocation(Function<AllocationRequest.Builder,ObjectBuilder<AllocationRequest>> fn)
                                    throws IOException,
ElasticsearchException

Provides a snapshot of the number of shards allocated to each data node and their disk space. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

allocation

public AllocationResponse allocation()
                              throws IOException,
ElasticsearchException

Provides a snapshot of the number of shards allocated to each data node and their disk space. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

componentTemplates

public ComponentTemplatesResponse componentTemplates(ComponentTemplatesRequest request)
                                              throws IOException,
ElasticsearchException

Returns information about component templates in a cluster. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get component template API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

componentTemplates

public final ComponentTemplatesResponse componentTemplates(Function<ComponentTemplatesRequest.Builder,ObjectBuilder<ComponentTemplatesRequest>> fn)
                                                    throws IOException,
ElasticsearchException

Returns information about component templates in a cluster. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get component template API.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

componentTemplates

public ComponentTemplatesResponse componentTemplates()
                                              throws IOException,
ElasticsearchException

Returns information about component templates in a cluster. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get component template API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

count

public CountResponse count(CountRequest request)
                    throws IOException,
ElasticsearchException

Provides quick access to a document count for a data stream, an index, or an entire cluster. NOTE: The document count only includes live documents, not deleted documents which have not yet been removed by the merge process. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the count API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

count

public final CountResponse count(Function<CountRequest.Builder,ObjectBuilder<CountRequest>> fn)
                          throws IOException,
ElasticsearchException

Provides quick access to a document count for a data stream, an index, or an entire cluster. NOTE: The document count only includes live documents, not deleted documents which have not yet been removed by the merge process. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the count API.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

count

public CountResponse count()
                    throws IOException,
ElasticsearchException

Provides quick access to a document count for a data stream, an index, or an entire cluster. NOTE: The document count only includes live documents, not deleted documents which have not yet been removed by the merge process. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the count API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

fielddata

public FielddataResponse fielddata(FielddataRequest request)
                            throws IOException,
ElasticsearchException

Returns the amount of heap memory currently used by the field data cache on every data node in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes stats API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

fielddata

public final FielddataResponse fielddata(Function<FielddataRequest.Builder,ObjectBuilder<FielddataRequest>> fn)
                                  throws IOException,
ElasticsearchException

Returns the amount of heap memory currently used by the field data cache on every data node in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes stats API.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

fielddata

public FielddataResponse fielddata()
                            throws IOException,
ElasticsearchException

Returns the amount of heap memory currently used by the field data cache on every data node in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes stats API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

health

public HealthResponse health(HealthRequest request)
                      throws IOException,
ElasticsearchException

Returns the health status of a cluster, similar to the cluster health API. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the cluster health API. This API is often used to check malfunctioning clusters. To help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats: HH:MM:SS, which is human-readable but includes no date information; Unix epoch time, which is machine-sortable and includes date information. The latter format is useful for cluster recoveries that take multiple days. You can use the cat health API to verify cluster health across multiple nodes. You also can use the API to track the recovery of a large cluster over a longer period of time.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

health

public final HealthResponse health(Function<HealthRequest.Builder,ObjectBuilder<HealthRequest>> fn)
                            throws IOException,
ElasticsearchException

Returns the health status of a cluster, similar to the cluster health API. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the cluster health API. This API is often used to check malfunctioning clusters. To help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats: HH:MM:SS, which is human-readable but includes no date information; Unix epoch time, which is machine-sortable and includes date information. The latter format is useful for cluster recoveries that take multiple days. You can use the cat health API to verify cluster health across multiple nodes. You also can use the API to track the recovery of a large cluster over a longer period of time.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

health

public HealthResponse health()
                      throws IOException,
ElasticsearchException

Returns the health status of a cluster, similar to the cluster health API. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the cluster health API. This API is often used to check malfunctioning clusters. To help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats: HH:MM:SS, which is human-readable but includes no date information; Unix epoch time, which is machine-sortable and includes date information. The latter format is useful for cluster recoveries that take multiple days. You can use the cat health API to verify cluster health across multiple nodes. You also can use the API to track the recovery of a large cluster over a longer period of time.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

help

public HelpResponse help()
                  throws IOException,
ElasticsearchException

Returns help for the Cat APIs.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

indices

public IndicesResponse indices(IndicesRequest request)
                        throws IOException,
ElasticsearchException

Returns high-level information about indices in a cluster, including backing indices for data streams. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index API. Use the cat indices API to get the following information for each index in a cluster: shard count; document count; deleted document count; primary store size; total store size of all shards, including shard replicas. These metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents. To get an accurate count of Elasticsearch documents, use the cat count or count APIs.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

indices

public final IndicesResponse indices(Function<IndicesRequest.Builder,ObjectBuilder<IndicesRequest>> fn)
                              throws IOException,
ElasticsearchException

Returns high-level information about indices in a cluster, including backing indices for data streams. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index API. Use the cat indices API to get the following information for each index in a cluster: shard count; document count; deleted document count; primary store size; total store size of all shards, including shard replicas. These metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents. To get an accurate count of Elasticsearch documents, use the cat count or count APIs.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

indices

public IndicesResponse indices()
                        throws IOException,
ElasticsearchException

Returns high-level information about indices in a cluster, including backing indices for data streams. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index API. Use the cat indices API to get the following information for each index in a cluster: shard count; document count; deleted document count; primary store size; total store size of all shards, including shard replicas. These metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents. To get an accurate count of Elasticsearch documents, use the cat count or count APIs.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

master

public MasterResponse master()
                      throws IOException,
ElasticsearchException

Returns information about the master node, including the ID, bound IP address, and name. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

mlDataFrameAnalytics

public MlDataFrameAnalyticsResponse mlDataFrameAnalytics(MlDataFrameAnalyticsRequest request)
                                                  throws IOException,
ElasticsearchException

Returns configuration and usage information about data frame analytics jobs.

IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get data frame analytics jobs statistics API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

mlDataFrameAnalytics

public final MlDataFrameAnalyticsResponse mlDataFrameAnalytics(Function<MlDataFrameAnalyticsRequest.Builder,ObjectBuilder<MlDataFrameAnalyticsRequest>> fn)
                                                        throws IOException,
ElasticsearchException

Returns configuration and usage information about data frame analytics jobs.

IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get data frame analytics jobs statistics API.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

mlDataFrameAnalytics

public MlDataFrameAnalyticsResponse mlDataFrameAnalytics()
                                                  throws IOException,
ElasticsearchException

Returns configuration and usage information about data frame analytics jobs.

IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get data frame analytics jobs statistics API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

mlDatafeeds

public MlDatafeedsResponse mlDatafeeds(MlDatafeedsRequest request)
                                throws IOException,
ElasticsearchException

Returns configuration and usage information about datafeeds. This API returns a maximum of 10,000 datafeeds. If the Elasticsearch security features are enabled, you must have monitor_ml, monitor, manage_ml, or manage cluster privileges to use this API.

IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get datafeed statistics API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

mlDatafeeds

public final MlDatafeedsResponse mlDatafeeds(Function<MlDatafeedsRequest.Builder,ObjectBuilder<MlDatafeedsRequest>> fn)
                                      throws IOException,
ElasticsearchException

Returns configuration and usage information about datafeeds. This API returns a maximum of 10,000 datafeeds. If the Elasticsearch security features are enabled, you must have monitor_ml, monitor, manage_ml, or manage cluster privileges to use this API.

IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get datafeed statistics API.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

mlDatafeeds

public MlDatafeedsResponse mlDatafeeds()
                                throws IOException,
ElasticsearchException

Returns configuration and usage information about datafeeds. This API returns a maximum of 10,000 datafeeds. If the Elasticsearch security features are enabled, you must have monitor_ml, monitor, manage_ml, or manage cluster privileges to use this API.

IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get datafeed statistics API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

mlJobs

public MlJobsResponse mlJobs(MlJobsRequest request)
                      throws IOException,
ElasticsearchException

Returns configuration and usage information for anomaly detection jobs. This API returns a maximum of 10,000 jobs. If the Elasticsearch security features are enabled, you must have monitor_ml, monitor, manage_ml, or manage cluster privileges to use this API.

IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get anomaly detection job statistics API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

mlJobs

public final MlJobsResponse mlJobs(Function<MlJobsRequest.Builder,ObjectBuilder<MlJobsRequest>> fn)
                            throws IOException,
ElasticsearchException

Returns configuration and usage information for anomaly detection jobs. This API returns a maximum of 10,000 jobs. If the Elasticsearch security features are enabled, you must have monitor_ml, monitor, manage_ml, or manage cluster privileges to use this API.

IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get anomaly detection job statistics API.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

mlJobs

public MlJobsResponse mlJobs()
                      throws IOException,
ElasticsearchException

Returns configuration and usage information for anomaly detection jobs. This API returns a maximum of 10,000 jobs. If the Elasticsearch security features are enabled, you must have monitor_ml, monitor, manage_ml, or manage cluster privileges to use this API.

IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get anomaly detection job statistics API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

mlTrainedModels

public MlTrainedModelsResponse mlTrainedModels(MlTrainedModelsRequest request)
                                        throws IOException,
ElasticsearchException

Returns configuration and usage information about inference trained models.

IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get trained models statistics API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

mlTrainedModels

public final MlTrainedModelsResponse mlTrainedModels(Function<MlTrainedModelsRequest.Builder,ObjectBuilder<MlTrainedModelsRequest>> fn)
                                              throws IOException,
ElasticsearchException

Returns configuration and usage information about inference trained models.

IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get trained models statistics API.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

mlTrainedModels

public MlTrainedModelsResponse mlTrainedModels()
                                        throws IOException,
ElasticsearchException

Returns configuration and usage information about inference trained models.

IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get trained models statistics API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

nodeattrs

public NodeattrsResponse nodeattrs()
                            throws IOException,
ElasticsearchException

Returns information about custom node attributes. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

nodes

public NodesResponse nodes(NodesRequest request)
                    throws IOException,
ElasticsearchException

Returns information about the nodes in a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

nodes

public final NodesResponse nodes(Function<NodesRequest.Builder,ObjectBuilder<NodesRequest>> fn)
                          throws IOException,
ElasticsearchException

Returns information about the nodes in a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

nodes

public NodesResponse nodes()
                    throws IOException,
ElasticsearchException

Returns information about the nodes in a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

pendingTasks

public PendingTasksResponse pendingTasks()
                                  throws IOException,
ElasticsearchException

Returns cluster-level changes that have not yet been executed. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the pending cluster tasks API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

plugins

public PluginsResponse plugins()
                        throws IOException,
ElasticsearchException

Returns a list of plugins running on each node of a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

recovery

public RecoveryResponse recovery(RecoveryRequest request)
                          throws IOException,
ElasticsearchException

Returns information about ongoing and completed shard recoveries. Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing. For data streams, the API returns information about the stream’s backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

recovery

public final RecoveryResponse recovery(Function<RecoveryRequest.Builder,ObjectBuilder<RecoveryRequest>> fn)
                                throws IOException,
ElasticsearchException

Returns information about ongoing and completed shard recoveries. Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing. For data streams, the API returns information about the stream’s backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

recovery

public RecoveryResponse recovery()
                          throws IOException,
ElasticsearchException

Returns information about ongoing and completed shard recoveries. Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing. For data streams, the API returns information about the stream’s backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

repositories

public RepositoriesResponse repositories()
                                  throws IOException,
ElasticsearchException

Returns the snapshot repositories for a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot repository API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

segments

public SegmentsResponse segments(SegmentsRequest request)
                          throws IOException,
ElasticsearchException

Returns low-level information about the Lucene segments in index shards. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

segments

public final SegmentsResponse segments(Function<SegmentsRequest.Builder,ObjectBuilder<SegmentsRequest>> fn)
                                throws IOException,
ElasticsearchException

Returns low-level information about the Lucene segments in index shards. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

segments

public SegmentsResponse segments()
                          throws IOException,
ElasticsearchException

Returns low-level information about the Lucene segments in index shards. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

shards

public ShardsResponse shards(ShardsRequest request)
                      throws IOException,
ElasticsearchException

Returns information about the shards in a cluster. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

shards

public final ShardsResponse shards(Function<ShardsRequest.Builder,ObjectBuilder<ShardsRequest>> fn)
                            throws IOException,
ElasticsearchException

Returns information about the shards in a cluster. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

shards

public ShardsResponse shards()
                      throws IOException,
ElasticsearchException

Returns information about the shards in a cluster. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

snapshots

public SnapshotsResponse snapshots(SnapshotsRequest request)
                            throws IOException,
ElasticsearchException

Returns information about the snapshots stored in one or more repositories. A snapshot is a backup of an index or running Elasticsearch cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

snapshots

public final SnapshotsResponse snapshots(Function<SnapshotsRequest.Builder,ObjectBuilder<SnapshotsRequest>> fn)
                                  throws IOException,
ElasticsearchException

Returns information about the snapshots stored in one or more repositories. A snapshot is a backup of an index or running Elasticsearch cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

snapshots

public SnapshotsResponse snapshots()
                            throws IOException,
ElasticsearchException

Returns information about the snapshots stored in one or more repositories. A snapshot is a backup of an index or running Elasticsearch cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

tasks

public TasksResponse tasks(TasksRequest request)
                    throws IOException,
ElasticsearchException

Returns information about tasks currently executing in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

tasks

public final TasksResponse tasks(Function<TasksRequest.Builder,ObjectBuilder<TasksRequest>> fn)
                          throws IOException,
ElasticsearchException

Returns information about tasks currently executing in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

tasks

public TasksResponse tasks()
                    throws IOException,
ElasticsearchException

Returns information about tasks currently executing in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

templates

public TemplatesResponse templates(TemplatesRequest request)
                            throws IOException,
ElasticsearchException

Returns information about index templates in a cluster. You can use index templates to apply index settings and field mappings to new indices at creation. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

templates

public final TemplatesResponse templates(Function<TemplatesRequest.Builder,ObjectBuilder<TemplatesRequest>> fn)
                                  throws IOException,
ElasticsearchException

Returns information about index templates in a cluster. You can use index templates to apply index settings and field mappings to new indices at creation. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

templates

public TemplatesResponse templates()
                            throws IOException,
ElasticsearchException

Returns information about index templates in a cluster. You can use index templates to apply index settings and field mappings to new indices at creation. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

threadPool

public ThreadPoolResponse threadPool(ThreadPoolRequest request)
                              throws IOException,
ElasticsearchException

Returns thread pool statistics for each node in a cluster. Returned information includes all built-in thread pools and custom thread pools. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

threadPool

public final ThreadPoolResponse threadPool(Function<ThreadPoolRequest.Builder,ObjectBuilder<ThreadPoolRequest>> fn)
                                    throws IOException,
ElasticsearchException

Returns thread pool statistics for each node in a cluster. Returned information includes all built-in thread pools and custom thread pools. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

threadPool

public ThreadPoolResponse threadPool()
                              throws IOException,
ElasticsearchException

Returns thread pool statistics for each node in a cluster. Returned information includes all built-in thread pools and custom thread pools. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

transforms

public TransformsResponse transforms(TransformsRequest request)
                              throws IOException,
ElasticsearchException

Returns configuration and usage information about transforms.

IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get transform statistics API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

transforms

public final TransformsResponse transforms(Function<TransformsRequest.Builder,ObjectBuilder<TransformsRequest>> fn)
                                    throws IOException,
ElasticsearchException

Returns configuration and usage information about transforms.

IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get transform statistics API.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

transforms

public TransformsResponse transforms()
                              throws IOException,
ElasticsearchException

Returns configuration and usage information about transforms.

IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get transform statistics API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co