Package co.elastic.clients.elasticsearch.cat

Class ElasticsearchCatClient

java.lang.Object

co.elastic.clients.base.ApiClient

co.elastic.clients.elasticsearch.cat.ElasticsearchCatClient

public class ElasticsearchCatClient
extends ApiClient

Client for the cat namespace.

Field Summary

Fields inherited from class co.elastic.clients.base.ApiClient

transport

Constructor Summary

Constructors

Constructor	Description
ElasticsearchCatClient(Transport transport)

Method Summary

Modifier and Type	Method	Description
AliasesResponse	aliases(AliasesRequest request)	Shows information about currently configured aliases to indices including filter and routing infos.
AliasesResponse	aliases(java.util.function.Function<AliasesRequest.Builder,ObjectBuilder<AliasesRequest>> fn)	Shows information about currently configured aliases to indices including filter and routing infos.
AllocationResponse	allocation(AllocationRequest request)	Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.
AllocationResponse	allocation(java.util.function.Function<AllocationRequest.Builder,ObjectBuilder<AllocationRequest>> fn)	Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.
CountResponse	count(CountRequest request)	Provides quick access to the document count of the entire cluster, or individual indices.
CountResponse	count(java.util.function.Function<CountRequest.Builder,ObjectBuilder<CountRequest>> fn)	Provides quick access to the document count of the entire cluster, or individual indices.
FielddataResponse	fielddata(FielddataRequest request)	Shows how much heap memory is currently being used by fielddata on every data node in the cluster.
FielddataResponse	fielddata(java.util.function.Function<FielddataRequest.Builder,ObjectBuilder<FielddataRequest>> fn)	Shows how much heap memory is currently being used by fielddata on every data node in the cluster.
HealthResponse	health(HealthRequest request)	Returns a concise representation of the cluster health.
HealthResponse	health(java.util.function.Function<HealthRequest.Builder,ObjectBuilder<HealthRequest>> fn)	Returns a concise representation of the cluster health.
HelpResponse	help()	Returns help for the Cat APIs.
IndicesResponse	indices(IndicesRequest request)	Returns information about indices: number of primaries and replicas, document counts, disk size, ...
IndicesResponse	indices(java.util.function.Function<IndicesRequest.Builder,ObjectBuilder<IndicesRequest>> fn)	Returns information about indices: number of primaries and replicas, document counts, disk size, ...
MasterResponse	master()	Returns information about the master node.
MlDatafeedsResponse	mlDatafeeds(MlDatafeedsRequest request)	Gets configuration and usage information about datafeeds.
MlDatafeedsResponse	mlDatafeeds(java.util.function.Function<MlDatafeedsRequest.Builder,ObjectBuilder<MlDatafeedsRequest>> fn)	Gets configuration and usage information about datafeeds.
MlDataFrameAnalyticsResponse	mlDataFrameAnalytics(MlDataFrameAnalyticsRequest request)	Gets configuration and usage information about data frame analytics jobs.
MlDataFrameAnalyticsResponse	mlDataFrameAnalytics(java.util.function.Function<MlDataFrameAnalyticsRequest.Builder,ObjectBuilder<MlDataFrameAnalyticsRequest>> fn)	Gets configuration and usage information about data frame analytics jobs.
MlJobsResponse	mlJobs(MlJobsRequest request)	Gets configuration and usage information about anomaly detection jobs.
MlJobsResponse	mlJobs(java.util.function.Function<MlJobsRequest.Builder,ObjectBuilder<MlJobsRequest>> fn)	Gets configuration and usage information about anomaly detection jobs.
MlTrainedModelsResponse	mlTrainedModels(MlTrainedModelsRequest request)	Gets configuration and usage information about inference trained models.
MlTrainedModelsResponse	mlTrainedModels(java.util.function.Function<MlTrainedModelsRequest.Builder,ObjectBuilder<MlTrainedModelsRequest>> fn)	Gets configuration and usage information about inference trained models.
NodeattrsResponse	nodeattrs()	Returns information about custom node attributes.
NodesResponse	nodes(NodesRequest request)	Returns basic statistics about performance of cluster nodes.
NodesResponse	nodes(java.util.function.Function<NodesRequest.Builder,ObjectBuilder<NodesRequest>> fn)	Returns basic statistics about performance of cluster nodes.
PendingTasksResponse	pendingTasks()	Returns a concise representation of the cluster pending tasks.
PluginsResponse	plugins()	Returns information about installed plugins across nodes node.
RecoveryResponse	recovery(RecoveryRequest request)	Returns information about index shard recoveries, both on-going completed.
RecoveryResponse	recovery(java.util.function.Function<RecoveryRequest.Builder,ObjectBuilder<RecoveryRequest>> fn)	Returns information about index shard recoveries, both on-going completed.
RepositoriesResponse	repositories()	Returns information about snapshot repositories registered in the cluster.
SegmentsResponse	segments(SegmentsRequest request)	Provides low-level information about the segments in the shards of an index.
SegmentsResponse	segments(java.util.function.Function<SegmentsRequest.Builder,ObjectBuilder<SegmentsRequest>> fn)	Provides low-level information about the segments in the shards of an index.
ShardsResponse	shards(ShardsRequest request)	Provides a detailed view of shard allocation on nodes.
ShardsResponse	shards(java.util.function.Function<ShardsRequest.Builder,ObjectBuilder<ShardsRequest>> fn)	Provides a detailed view of shard allocation on nodes.
SnapshotsResponse	snapshots(SnapshotsRequest request)	Returns all snapshots in a specific repository.
SnapshotsResponse	snapshots(java.util.function.Function<SnapshotsRequest.Builder,ObjectBuilder<SnapshotsRequest>> fn)	Returns all snapshots in a specific repository.
TasksResponse	tasks(TasksRequest request)	Returns information about the tasks currently executing on one or more nodes in the cluster.
TasksResponse	tasks(java.util.function.Function<TasksRequest.Builder,ObjectBuilder<TasksRequest>> fn)	Returns information about the tasks currently executing on one or more nodes in the cluster.
TemplatesResponse	templates(TemplatesRequest request)	Returns information about existing templates.
TemplatesResponse	templates(java.util.function.Function<TemplatesRequest.Builder,ObjectBuilder<TemplatesRequest>> fn)	Returns information about existing templates.
ThreadPoolResponse	threadPool(ThreadPoolRequest request)	Returns cluster-wide thread pool statistics per node.
ThreadPoolResponse	threadPool(java.util.function.Function<ThreadPoolRequest.Builder,ObjectBuilder<ThreadPoolRequest>> fn)	Returns cluster-wide thread pool statistics per node.
TransformsResponse	transforms(TransformsRequest request)	Gets configuration and usage information about transforms.
TransformsResponse	transforms(java.util.function.Function<TransformsRequest.Builder,ObjectBuilder<TransformsRequest>> fn)	Gets configuration and usage information about transforms.

Methods inherited from class co.elastic.clients.base.ApiClient

_transport, getDeserializer

Methods inherited from class java.lang.Object

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

Constructor Details

ElasticsearchCatClient

public ElasticsearchCatClient(Transport transport)

Method Details

aliases

public AliasesResponse aliases(AliasesRequest request)
                        throws java.io.IOException

Shows information about currently configured aliases to indices including filter and routing infos.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

aliases

public final AliasesResponse aliases(java.util.function.Function<AliasesRequest.Builder,ObjectBuilder<AliasesRequest>> fn)
                              throws java.io.IOException

Shows information about currently configured aliases to indices including filter and routing infos.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

allocation

public AllocationResponse allocation(AllocationRequest request)
                              throws java.io.IOException

Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

allocation

public final AllocationResponse allocation(java.util.function.Function<AllocationRequest.Builder,ObjectBuilder<AllocationRequest>> fn)
                                    throws java.io.IOException

Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

count

public CountResponse count(CountRequest request)
                    throws java.io.IOException

Provides quick access to the document count of the entire cluster, or individual indices.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

count

public final CountResponse count(java.util.function.Function<CountRequest.Builder,ObjectBuilder<CountRequest>> fn)
                          throws java.io.IOException

Provides quick access to the document count of the entire cluster, or individual indices.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

fielddata

public FielddataResponse fielddata(FielddataRequest request)
                            throws java.io.IOException

Shows how much heap memory is currently being used by fielddata on every data node in the cluster.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

fielddata

public final FielddataResponse fielddata(java.util.function.Function<FielddataRequest.Builder,ObjectBuilder<FielddataRequest>> fn)
                                  throws java.io.IOException

Shows how much heap memory is currently being used by fielddata on every data node in the cluster.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

health

public HealthResponse health(HealthRequest request)
                      throws java.io.IOException

Returns a concise representation of the cluster health.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

health

public final HealthResponse health(java.util.function.Function<HealthRequest.Builder,ObjectBuilder<HealthRequest>> fn)
                            throws java.io.IOException

Returns a concise representation of the cluster health.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

help

public HelpResponse help()
                  throws java.io.IOException

Returns help for the Cat APIs.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

indices

public IndicesResponse indices(IndicesRequest request)
                        throws java.io.IOException

Returns information about indices: number of primaries and replicas, document counts, disk size, ...

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

indices

public final IndicesResponse indices(java.util.function.Function<IndicesRequest.Builder,ObjectBuilder<IndicesRequest>> fn)
                              throws java.io.IOException

Returns information about indices: number of primaries and replicas, document counts, disk size, ...

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

master

public MasterResponse master()
                      throws java.io.IOException

Returns information about the master node.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

mlDataFrameAnalytics

public MlDataFrameAnalyticsResponse mlDataFrameAnalytics(MlDataFrameAnalyticsRequest request)
                                                  throws java.io.IOException

Gets configuration and usage information about data frame analytics jobs.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

mlDataFrameAnalytics

public final MlDataFrameAnalyticsResponse mlDataFrameAnalytics(java.util.function.Function<MlDataFrameAnalyticsRequest.Builder,ObjectBuilder<MlDataFrameAnalyticsRequest>> fn)
                                                        throws java.io.IOException

Gets configuration and usage information about data frame analytics jobs.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

mlDatafeeds

public MlDatafeedsResponse mlDatafeeds(MlDatafeedsRequest request)
                                throws java.io.IOException

Gets configuration and usage information about datafeeds.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

mlDatafeeds

public final MlDatafeedsResponse mlDatafeeds(java.util.function.Function<MlDatafeedsRequest.Builder,ObjectBuilder<MlDatafeedsRequest>> fn)
                                      throws java.io.IOException

Gets configuration and usage information about datafeeds.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

mlJobs

public MlJobsResponse mlJobs(MlJobsRequest request)
                      throws java.io.IOException

Gets configuration and usage information about anomaly detection jobs.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

mlJobs

public final MlJobsResponse mlJobs(java.util.function.Function<MlJobsRequest.Builder,ObjectBuilder<MlJobsRequest>> fn)
                            throws java.io.IOException

Gets configuration and usage information about anomaly detection jobs.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

mlTrainedModels

public MlTrainedModelsResponse mlTrainedModels(MlTrainedModelsRequest request)
                                        throws java.io.IOException

Gets configuration and usage information about inference trained models.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

mlTrainedModels

public final MlTrainedModelsResponse mlTrainedModels(java.util.function.Function<MlTrainedModelsRequest.Builder,ObjectBuilder<MlTrainedModelsRequest>> fn)
                                              throws java.io.IOException

Gets configuration and usage information about inference trained models.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

nodeattrs

public NodeattrsResponse nodeattrs()
                            throws java.io.IOException

Returns information about custom node attributes.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

nodes

public NodesResponse nodes(NodesRequest request)
                    throws java.io.IOException

Returns basic statistics about performance of cluster nodes.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

nodes

public final NodesResponse nodes(java.util.function.Function<NodesRequest.Builder,ObjectBuilder<NodesRequest>> fn)
                          throws java.io.IOException

Returns basic statistics about performance of cluster nodes.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

pendingTasks

public PendingTasksResponse pendingTasks()
                                  throws java.io.IOException

Returns a concise representation of the cluster pending tasks.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

plugins

public PluginsResponse plugins()
                        throws java.io.IOException

Returns information about installed plugins across nodes node.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

recovery

public RecoveryResponse recovery(RecoveryRequest request)
                          throws java.io.IOException

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

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

recovery

public final RecoveryResponse recovery(java.util.function.Function<RecoveryRequest.Builder,ObjectBuilder<RecoveryRequest>> fn)
                                throws java.io.IOException

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

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

repositories

public RepositoriesResponse repositories()
                                  throws java.io.IOException

Returns information about snapshot repositories registered in the cluster.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

segments

public SegmentsResponse segments(SegmentsRequest request)
                          throws java.io.IOException

Provides low-level information about the segments in the shards of an index.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

segments

public final SegmentsResponse segments(java.util.function.Function<SegmentsRequest.Builder,ObjectBuilder<SegmentsRequest>> fn)
                                throws java.io.IOException

Provides low-level information about the segments in the shards of an index.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

shards

public ShardsResponse shards(ShardsRequest request)
                      throws java.io.IOException

Provides a detailed view of shard allocation on nodes.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

shards

public final ShardsResponse shards(java.util.function.Function<ShardsRequest.Builder,ObjectBuilder<ShardsRequest>> fn)
                            throws java.io.IOException

Provides a detailed view of shard allocation on nodes.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

snapshots

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

Returns all snapshots in a specific repository.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

snapshots

public final SnapshotsResponse snapshots(java.util.function.Function<SnapshotsRequest.Builder,ObjectBuilder<SnapshotsRequest>> fn)
                                  throws java.io.IOException

Returns all snapshots in a specific repository.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

tasks

public TasksResponse tasks(TasksRequest request)
                    throws java.io.IOException

Returns information about the tasks currently executing on one or more nodes in the cluster.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

tasks

public final TasksResponse tasks(java.util.function.Function<TasksRequest.Builder,ObjectBuilder<TasksRequest>> fn)
                          throws java.io.IOException

Returns information about the tasks currently executing on one or more nodes in the cluster.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

templates

public TemplatesResponse templates(TemplatesRequest request)
                            throws java.io.IOException

Returns information about existing templates.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

templates

public final TemplatesResponse templates(java.util.function.Function<TemplatesRequest.Builder,ObjectBuilder<TemplatesRequest>> fn)
                                  throws java.io.IOException

Returns information about existing templates.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

threadPool

public ThreadPoolResponse threadPool(ThreadPoolRequest request)
                              throws java.io.IOException

Returns cluster-wide thread pool statistics per node. By default the active, queue and rejected statistics are returned for all thread pools.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

threadPool

public final ThreadPoolResponse threadPool(java.util.function.Function<ThreadPoolRequest.Builder,ObjectBuilder<ThreadPoolRequest>> fn)
                                    throws java.io.IOException

Returns cluster-wide thread pool statistics per node. By default the active, queue and rejected statistics are returned for all thread pools.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

transforms

public TransformsResponse transforms(TransformsRequest request)
                              throws java.io.IOException

Gets configuration and usage information about transforms.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

transforms

public final TransformsResponse transforms(java.util.function.Function<TransformsRequest.Builder,ObjectBuilder<TransformsRequest>> fn)
                                    throws java.io.IOException

Gets configuration and usage information about transforms.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co