Package co.elastic.clients.elasticsearch.cat

Class ElasticsearchCatAsyncClient

java.lang.Object
co.elastic.clients.ApiClient<ElasticsearchTransport,ElasticsearchCatAsyncClient>
co.elastic.clients.elasticsearch.cat.ElasticsearchCatAsyncClient
All Implemented Interfaces:
Closeable, AutoCloseable
public class ElasticsearchCatAsyncClient extends ApiClient<ElasticsearchTransport,ElasticsearchCatAsyncClient>
Client for the cat namespace.

  • Constructor Details

  • Method Details

    • withTransportOptions

      public ElasticsearchCatAsyncClient withTransportOptions(@Nullable TransportOptions transportOptions)
      Description copied from class: ApiClient
      Creates a new client with some request options
      Specified by:
      withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchCatAsyncClient>

    • aliases

      public CompletableFuture<AliasesResponse> aliases(AliasesRequest request)
      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.

      See Also:

    • aliases

      public final CompletableFuture<AliasesResponse> aliases(Function<AliasesRequest.Builder,ObjectBuilder<AliasesRequest>> fn)
      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
      See Also:

    • aliases

      public CompletableFuture<AliasesResponse> aliases()
      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.

      See Also:

    • allocation

      public CompletableFuture<AllocationResponse> allocation(AllocationRequest request)
      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.

      See Also:

    • allocation

      public final CompletableFuture<AllocationResponse> allocation(Function<AllocationRequest.Builder,ObjectBuilder<AllocationRequest>> fn)
      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
      See Also:

    • allocation

      public CompletableFuture<AllocationResponse> allocation()
      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.

      See Also:

    • componentTemplates

      public CompletableFuture<ComponentTemplatesResponse> componentTemplates(ComponentTemplatesRequest request)
      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.

      See Also:

    • componentTemplates

      public final CompletableFuture<ComponentTemplatesResponse> componentTemplates(Function<ComponentTemplatesRequest.Builder,ObjectBuilder<ComponentTemplatesRequest>> fn)
      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
      See Also:

    • componentTemplates

      public CompletableFuture<ComponentTemplatesResponse> componentTemplates()
      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.

      See Also:

    • count

      public CompletableFuture<CountResponse> count(CountRequest request)
      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.

      See Also:

    • count

      public final CompletableFuture<CountResponse> count(Function<CountRequest.Builder,ObjectBuilder<CountRequest>> fn)
      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
      See Also:

    • count

      public CompletableFuture<CountResponse> count()
      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.

      See Also:

    • fielddata

      public CompletableFuture<FielddataResponse> fielddata(FielddataRequest request)
      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.

      See Also:

    • fielddata

      public final CompletableFuture<FielddataResponse> fielddata(Function<FielddataRequest.Builder,ObjectBuilder<FielddataRequest>> fn)
      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
      See Also:

    • fielddata

      public CompletableFuture<FielddataResponse> fielddata()
      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.

      See Also:

    • health

      public CompletableFuture<HealthResponse> health(HealthRequest request)
      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.

      See Also:

    • health

      public final CompletableFuture<HealthResponse> health(Function<HealthRequest.Builder,ObjectBuilder<HealthRequest>> fn)
      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
      See Also:

    • health

      public CompletableFuture<HealthResponse> health()
      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.

      See Also:

    • help

      public CompletableFuture<HelpResponse> help()
      Get CAT help.

      Get help for the CAT APIs.

      See Also:

    • indices

      public CompletableFuture<IndicesResponse> indices(IndicesRequest request)
      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.

      See Also:

    • indices

      public final CompletableFuture<IndicesResponse> indices(Function<IndicesRequest.Builder,ObjectBuilder<IndicesRequest>> fn)
      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
      See Also:

    • indices

      public CompletableFuture<IndicesResponse> indices()
      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.

      See Also:

    • master

      public CompletableFuture<MasterResponse> master(MasterRequest request)
      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.

      See Also:

    • master

      public final CompletableFuture<MasterResponse> master(Function<MasterRequest.Builder,ObjectBuilder<MasterRequest>> fn)
      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
      See Also:

    • master

      public CompletableFuture<MasterResponse> master()
      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.

      See Also:

    • mlDataFrameAnalytics

      public CompletableFuture<MlDataFrameAnalyticsResponse> mlDataFrameAnalytics(MlDataFrameAnalyticsRequest request)
      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.

      See Also:

    • mlDataFrameAnalytics

      public final CompletableFuture<MlDataFrameAnalyticsResponse> mlDataFrameAnalytics(Function<MlDataFrameAnalyticsRequest.Builder,ObjectBuilder<MlDataFrameAnalyticsRequest>> fn)
      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
      See Also:

    • mlDataFrameAnalytics

      public CompletableFuture<MlDataFrameAnalyticsResponse> mlDataFrameAnalytics()
      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.

      See Also:

    • mlDatafeeds

      public CompletableFuture<MlDatafeedsResponse> mlDatafeeds(MlDatafeedsRequest request)
      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.

      See Also:

    • mlDatafeeds

      public final CompletableFuture<MlDatafeedsResponse> mlDatafeeds(Function<MlDatafeedsRequest.Builder,ObjectBuilder<MlDatafeedsRequest>> fn)
      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
      See Also:

    • mlDatafeeds

      public CompletableFuture<MlDatafeedsResponse> mlDatafeeds()
      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.

      See Also:

    • mlJobs

      public CompletableFuture<MlJobsResponse> mlJobs(MlJobsRequest request)
      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.

      See Also:

    • mlJobs

      public final CompletableFuture<MlJobsResponse> mlJobs(Function<MlJobsRequest.Builder,ObjectBuilder<MlJobsRequest>> fn)
      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
      See Also:

    • mlJobs

      public CompletableFuture<MlJobsResponse> mlJobs()
      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.

      See Also:

    • mlTrainedModels

      public CompletableFuture<MlTrainedModelsResponse> mlTrainedModels(MlTrainedModelsRequest request)
      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.

      See Also:

    • mlTrainedModels

      public final CompletableFuture<MlTrainedModelsResponse> mlTrainedModels(Function<MlTrainedModelsRequest.Builder,ObjectBuilder<MlTrainedModelsRequest>> fn)
      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
      See Also:

    • mlTrainedModels

      public CompletableFuture<MlTrainedModelsResponse> mlTrainedModels()
      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.

      See Also:

    • nodeattrs

      public CompletableFuture<NodeattrsResponse> nodeattrs(NodeattrsRequest request)
      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.

      See Also:

    • nodeattrs

      public final CompletableFuture<NodeattrsResponse> nodeattrs(Function<NodeattrsRequest.Builder,ObjectBuilder<NodeattrsRequest>> fn)
      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
      See Also:

    • nodeattrs

      public CompletableFuture<NodeattrsResponse> nodeattrs()
      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.

      See Also:

    • nodes

      public CompletableFuture<NodesResponse> nodes(NodesRequest request)
      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.

      See Also:

    • nodes

      public final CompletableFuture<NodesResponse> nodes(Function<NodesRequest.Builder,ObjectBuilder<NodesRequest>> fn)
      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
      See Also:

    • nodes

      public CompletableFuture<NodesResponse> nodes()
      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.

      See Also:

    • pendingTasks

      public CompletableFuture<PendingTasksResponse> pendingTasks(PendingTasksRequest request)
      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.

      See Also:

    • pendingTasks

      public final CompletableFuture<PendingTasksResponse> pendingTasks(Function<PendingTasksRequest.Builder,ObjectBuilder<PendingTasksRequest>> fn)
      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
      See Also:

    • pendingTasks

      public CompletableFuture<PendingTasksResponse> pendingTasks()
      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.

      See Also:

    • plugins

      public CompletableFuture<PluginsResponse> plugins(PluginsRequest request)
      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.

      See Also:

    • plugins

      public final CompletableFuture<PluginsResponse> plugins(Function<PluginsRequest.Builder,ObjectBuilder<PluginsRequest>> fn)
      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
      See Also:

    • plugins

      public CompletableFuture<PluginsResponse> plugins()
      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.

      See Also:

    • recovery

      public CompletableFuture<RecoveryResponse> recovery(RecoveryRequest request)
      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.

      See Also:

    • recovery

      public final CompletableFuture<RecoveryResponse> recovery(Function<RecoveryRequest.Builder,ObjectBuilder<RecoveryRequest>> fn)
      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
      See Also:

    • recovery

      public CompletableFuture<RecoveryResponse> recovery()
      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.

      See Also:

    • repositories

      public CompletableFuture<RepositoriesResponse> repositories(RepositoriesRequest request)
      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.

      See Also:

    • repositories

      public final CompletableFuture<RepositoriesResponse> repositories(Function<RepositoriesRequest.Builder,ObjectBuilder<RepositoriesRequest>> fn)
      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
      See Also:

    • repositories

      public CompletableFuture<RepositoriesResponse> repositories()
      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.

      See Also:

    • segments

      public CompletableFuture<SegmentsResponse> segments(SegmentsRequest request)
      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.

      See Also:

    • segments

      public final CompletableFuture<SegmentsResponse> segments(Function<SegmentsRequest.Builder,ObjectBuilder<SegmentsRequest>> fn)
      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
      See Also:

    • segments

      public CompletableFuture<SegmentsResponse> segments()
      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.

      See Also:

    • shards

      public CompletableFuture<ShardsResponse> shards(ShardsRequest request)
      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.

      See Also:

    • shards

      public final CompletableFuture<ShardsResponse> shards(Function<ShardsRequest.Builder,ObjectBuilder<ShardsRequest>> fn)
      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
      See Also:

    • shards

      public CompletableFuture<ShardsResponse> shards()
      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.

      See Also:

    • snapshots

      public CompletableFuture<SnapshotsResponse> snapshots(SnapshotsRequest request)
      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.

      See Also:

    • snapshots

      public final CompletableFuture<SnapshotsResponse> snapshots(Function<SnapshotsRequest.Builder,ObjectBuilder<SnapshotsRequest>> fn)
      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
      See Also:

    • snapshots

      public CompletableFuture<SnapshotsResponse> snapshots()
      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.

      See Also:

    • tasks

      public CompletableFuture<TasksResponse> tasks(TasksRequest request)
      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.

      See Also:

    • tasks

      public final CompletableFuture<TasksResponse> tasks(Function<TasksRequest.Builder,ObjectBuilder<TasksRequest>> fn)
      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
      See Also:

    • tasks

      public CompletableFuture<TasksResponse> tasks()
      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.

      See Also:

    • templates

      public CompletableFuture<TemplatesResponse> templates(TemplatesRequest request)
      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.

      See Also:

    • templates

      public final CompletableFuture<TemplatesResponse> templates(Function<TemplatesRequest.Builder,ObjectBuilder<TemplatesRequest>> fn)
      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
      See Also:

    • templates

      public CompletableFuture<TemplatesResponse> templates()
      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.

      See Also:

    • threadPool

      public CompletableFuture<ThreadPoolResponse> threadPool(ThreadPoolRequest request)
      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.

      See Also:

    • threadPool

      public final CompletableFuture<ThreadPoolResponse> threadPool(Function<ThreadPoolRequest.Builder,ObjectBuilder<ThreadPoolRequest>> fn)
      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
      See Also:

    • threadPool

      public CompletableFuture<ThreadPoolResponse> threadPool()
      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.

      See Also:

    • transforms

      public CompletableFuture<TransformsResponse> transforms(TransformsRequest request)
      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.

      See Also:

    • transforms

      public final CompletableFuture<TransformsResponse> transforms(Function<TransformsRequest.Builder,ObjectBuilder<TransformsRequest>> fn)
      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
      See Also:

    • transforms

      public CompletableFuture<TransformsResponse> transforms()
      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.

      See Also: