Package co.elastic.clients.elasticsearch.cat

Class ElasticsearchCatClient

java.lang.Object

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

co.elastic.clients.elasticsearch.cat.ElasticsearchCatClient

All Implemented Interfaces:

Closeable, AutoCloseable

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()	Get aliases.
AliasesResponse	aliases(AliasesRequest request)	Get aliases.
final AliasesResponse	aliases(Function<AliasesRequest.Builder,ObjectBuilder<AliasesRequest>> fn)	Get aliases.
AllocationResponse	allocation()	Get shard allocation information.
AllocationResponse	allocation(AllocationRequest request)	Get shard allocation information.
final AllocationResponse	allocation(Function<AllocationRequest.Builder,ObjectBuilder<AllocationRequest>> fn)	Get shard allocation information.
ComponentTemplatesResponse	componentTemplates()	Get component templates.
ComponentTemplatesResponse	componentTemplates(ComponentTemplatesRequest request)	Get component templates.
final ComponentTemplatesResponse	componentTemplates(Function<ComponentTemplatesRequest.Builder,ObjectBuilder<ComponentTemplatesRequest>> fn)	Get component templates.
CountResponse	count()	Get a document count.
CountResponse	count(CountRequest request)	Get a document count.
final CountResponse	count(Function<CountRequest.Builder,ObjectBuilder<CountRequest>> fn)	Get a document count.
FielddataResponse	fielddata()	Get field data cache information.
FielddataResponse	fielddata(FielddataRequest request)	Get field data cache information.
final FielddataResponse	fielddata(Function<FielddataRequest.Builder,ObjectBuilder<FielddataRequest>> fn)	Get field data cache information.
HealthResponse	health()	Get the cluster health status.
HealthResponse	health(HealthRequest request)	Get the cluster health status.
final HealthResponse	health(Function<HealthRequest.Builder,ObjectBuilder<HealthRequest>> fn)	Get the cluster health status.
HelpResponse	help()	Get CAT help.
IndicesResponse	indices()	Get index information.
IndicesResponse	indices(IndicesRequest request)	Get index information.
final IndicesResponse	indices(Function<IndicesRequest.Builder,ObjectBuilder<IndicesRequest>> fn)	Get index information.
MasterResponse	master()	Get master node information.
MasterResponse	master(MasterRequest request)	Get master node information.
final MasterResponse	master(Function<MasterRequest.Builder,ObjectBuilder<MasterRequest>> fn)	Get master node information.
MlDatafeedsResponse	mlDatafeeds()	Get datafeeds.
MlDatafeedsResponse	mlDatafeeds(MlDatafeedsRequest request)	Get datafeeds.
final MlDatafeedsResponse	mlDatafeeds(Function<MlDatafeedsRequest.Builder,ObjectBuilder<MlDatafeedsRequest>> fn)	Get datafeeds.
MlDataFrameAnalyticsResponse	mlDataFrameAnalytics()	Get data frame analytics jobs.
MlDataFrameAnalyticsResponse	mlDataFrameAnalytics(MlDataFrameAnalyticsRequest request)	Get data frame analytics jobs.
final MlDataFrameAnalyticsResponse	mlDataFrameAnalytics(Function<MlDataFrameAnalyticsRequest.Builder,ObjectBuilder<MlDataFrameAnalyticsRequest>> fn)	Get data frame analytics jobs.
MlJobsResponse	mlJobs()	Get anomaly detection jobs.
MlJobsResponse	mlJobs(MlJobsRequest request)	Get anomaly detection jobs.
final MlJobsResponse	mlJobs(Function<MlJobsRequest.Builder,ObjectBuilder<MlJobsRequest>> fn)	Get anomaly detection jobs.
MlTrainedModelsResponse	mlTrainedModels()	Get trained models.
MlTrainedModelsResponse	mlTrainedModels(MlTrainedModelsRequest request)	Get trained models.
final MlTrainedModelsResponse	mlTrainedModels(Function<MlTrainedModelsRequest.Builder,ObjectBuilder<MlTrainedModelsRequest>> fn)	Get trained models.
NodeattrsResponse	nodeattrs()	Get node attribute information.
NodeattrsResponse	nodeattrs(NodeattrsRequest request)	Get node attribute information.
final NodeattrsResponse	nodeattrs(Function<NodeattrsRequest.Builder,ObjectBuilder<NodeattrsRequest>> fn)	Get node attribute information.
NodesResponse	nodes()	Get node information.
NodesResponse	nodes(NodesRequest request)	Get node information.
final NodesResponse	nodes(Function<NodesRequest.Builder,ObjectBuilder<NodesRequest>> fn)	Get node information.
PendingTasksResponse	pendingTasks()	Get pending task information.
PendingTasksResponse	pendingTasks(PendingTasksRequest request)	Get pending task information.
final PendingTasksResponse	pendingTasks(Function<PendingTasksRequest.Builder,ObjectBuilder<PendingTasksRequest>> fn)	Get pending task information.
PluginsResponse	plugins()	Get plugin information.
PluginsResponse	plugins(PluginsRequest request)	Get plugin information.
final PluginsResponse	plugins(Function<PluginsRequest.Builder,ObjectBuilder<PluginsRequest>> fn)	Get plugin information.
RecoveryResponse	recovery()	Get shard recovery information.
RecoveryResponse	recovery(RecoveryRequest request)	Get shard recovery information.
final RecoveryResponse	recovery(Function<RecoveryRequest.Builder,ObjectBuilder<RecoveryRequest>> fn)	Get shard recovery information.
RepositoriesResponse	repositories()	Get snapshot repository information.
RepositoriesResponse	repositories(RepositoriesRequest request)	Get snapshot repository information.
final RepositoriesResponse	repositories(Function<RepositoriesRequest.Builder,ObjectBuilder<RepositoriesRequest>> fn)	Get snapshot repository information.
SegmentsResponse	segments()	Get segment information.
SegmentsResponse	segments(SegmentsRequest request)	Get segment information.
final SegmentsResponse	segments(Function<SegmentsRequest.Builder,ObjectBuilder<SegmentsRequest>> fn)	Get segment information.
ShardsResponse	shards()	Get shard information.
ShardsResponse	shards(ShardsRequest request)	Get shard information.
final ShardsResponse	shards(Function<ShardsRequest.Builder,ObjectBuilder<ShardsRequest>> fn)	Get shard information.
SnapshotsResponse	snapshots()	Get snapshot information.
SnapshotsResponse	snapshots(SnapshotsRequest request)	Get snapshot information.
final SnapshotsResponse	snapshots(Function<SnapshotsRequest.Builder,ObjectBuilder<SnapshotsRequest>> fn)	Get snapshot information.
TasksResponse	tasks()	Get task information.
TasksResponse	tasks(TasksRequest request)	Get task information.
final TasksResponse	tasks(Function<TasksRequest.Builder,ObjectBuilder<TasksRequest>> fn)	Get task information.
TemplatesResponse	templates()	Get index template information.
TemplatesResponse	templates(TemplatesRequest request)	Get index template information.
final TemplatesResponse	templates(Function<TemplatesRequest.Builder,ObjectBuilder<TemplatesRequest>> fn)	Get index template information.
ThreadPoolResponse	threadPool()	Get thread pool statistics.
ThreadPoolResponse	threadPool(ThreadPoolRequest request)	Get thread pool statistics.
final ThreadPoolResponse	threadPool(Function<ThreadPoolRequest.Builder,ObjectBuilder<ThreadPoolRequest>> fn)	Get thread pool statistics.
TransformsResponse	transforms()	Get transform information.
TransformsResponse	transforms(TransformsRequest request)	Get transform information.
final TransformsResponse	transforms(Function<TransformsRequest.Builder,ObjectBuilder<TransformsRequest>> fn)	Get transform information.
ElasticsearchCatClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class co.elastic.clients.ApiClient

_jsonpMapper, _transport, _transportOptions, close, 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

Get aliases.

Get the cluster's index aliases, including filter and routing information. This 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

Get aliases.

Get the cluster's index aliases, including filter and routing information. This 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

Get aliases.

Get the cluster's index aliases, including filter and routing information. This 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

Get shard allocation information.

Get 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

Get shard allocation information.

Get 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

Get shard allocation information.

Get 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

Get component templates.

Get 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

Get component templates.

Get 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

Get component templates.

Get 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

Get a document count.

Get quick access to a document count for a data stream, an index, or an entire cluster. 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

Get a document count.

Get quick access to a document count for a data stream, an index, or an entire cluster. 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

Get a document count.

Get quick access to a document count for a data stream, an index, or an entire cluster. 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

Get field data cache information.

Get 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

Get field data cache information.

Get 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

Get field data cache information.

Get 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

Get the cluster health status.

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

Get the cluster health status.

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

Get the cluster health status.

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

Get CAT help.

Get help for the CAT APIs.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

indices

public IndicesResponse indices(IndicesRequest request)
                        throws IOException,
ElasticsearchException

Get index information.

Get high-level information about indices in a cluster, including backing indices for data streams.

Use this request 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.

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 an index endpoint.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

indices

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

Get index information.

Get high-level information about indices in a cluster, including backing indices for data streams.

Use this request 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.

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 an index endpoint.

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

Get index information.

Get high-level information about indices in a cluster, including backing indices for data streams.

Use this request 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.

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 an index endpoint.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

master

public MasterResponse master(MasterRequest request)
                      throws IOException,
ElasticsearchException

Get master node information.

Get 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

master

public final MasterResponse master(Function<MasterRequest.Builder,ObjectBuilder<MasterRequest>> fn)
                            throws IOException,
ElasticsearchException

Get master node information.

Get 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.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

master

public MasterResponse master()
                      throws IOException,
ElasticsearchException

Get master node information.

Get 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

Get data frame analytics jobs.

Get 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

Get data frame analytics jobs.

Get 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

Get data frame analytics jobs.

Get 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

Get datafeeds.

Get 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

Get datafeeds.

Get 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

Get datafeeds.

Get 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

Get anomaly detection jobs.

Get 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

Get anomaly detection jobs.

Get 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

Get anomaly detection jobs.

Get 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

Get trained models.

Get 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

Get trained models.

Get 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

Get trained models.

Get 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(NodeattrsRequest request)
                            throws IOException,
ElasticsearchException

Get node attribute information.

Get 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

nodeattrs

public final NodeattrsResponse nodeattrs(Function<NodeattrsRequest.Builder,ObjectBuilder<NodeattrsRequest>> fn)
                                  throws IOException,
ElasticsearchException

Get node attribute information.

Get 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.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

nodeattrs

public NodeattrsResponse nodeattrs()
                            throws IOException,
ElasticsearchException

Get node attribute information.

Get 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

Get node information.

Get 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

Get node information.

Get 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

Get node information.

Get 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(PendingTasksRequest request)
                                  throws IOException,
ElasticsearchException

Get pending task information.

Get information about cluster-level changes that have not yet taken effect. 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

pendingTasks

public final PendingTasksResponse pendingTasks(Function<PendingTasksRequest.Builder,ObjectBuilder<PendingTasksRequest>> fn)
                                        throws IOException,
ElasticsearchException

Get pending task information.

Get information about cluster-level changes that have not yet taken effect. 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.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

pendingTasks

public PendingTasksResponse pendingTasks()
                                  throws IOException,
ElasticsearchException

Get pending task information.

Get information about cluster-level changes that have not yet taken effect. 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(PluginsRequest request)
                        throws IOException,
ElasticsearchException

Get plugin information.

Get 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

plugins

public final PluginsResponse plugins(Function<PluginsRequest.Builder,ObjectBuilder<PluginsRequest>> fn)
                              throws IOException,
ElasticsearchException

Get plugin information.

Get 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.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

plugins

public PluginsResponse plugins()
                        throws IOException,
ElasticsearchException

Get plugin information.

Get 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

Get shard recovery information.

Get 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

Get shard recovery information.

Get 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

Get shard recovery information.

Get 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(RepositoriesRequest request)
                                  throws IOException,
ElasticsearchException

Get snapshot repository information.

Get a list of 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

repositories

public final RepositoriesResponse repositories(Function<RepositoriesRequest.Builder,ObjectBuilder<RepositoriesRequest>> fn)
                                        throws IOException,
ElasticsearchException

Get snapshot repository information.

Get a list of 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.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

repositories

public RepositoriesResponse repositories()
                                  throws IOException,
ElasticsearchException

Get snapshot repository information.

Get a list of 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

Get segment information.

Get 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

Get segment information.

Get 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

Get segment information.

Get 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

Get shard information.

Get 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

Get shard information.

Get 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

Get shard information.

Get 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

Get snapshot information.

Get 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

Get snapshot information.

Get 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

Get snapshot information.

Get 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

Get task information.

Get information about tasks currently running 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

Get task information.

Get information about tasks currently running 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

Get task information.

Get information about tasks currently running 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

Get index template information.

Get information about the 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

Get index template information.

Get information about the 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

Get index template information.

Get information about the 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

Get thread pool statistics.

Get 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

Get thread pool statistics.

Get 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

Get thread pool statistics.

Get 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

Get transform information.

Get configuration and usage information about transforms.

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

Get transform information.

Get configuration and usage information about transforms.

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

Get transform information.

Get configuration and usage information about transforms.

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