Package co.elastic.clients.elasticsearch.cat

Class ElasticsearchCatClient

java.lang.Object

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

co.elastic.clients.elasticsearch.cat.ElasticsearchCatClient

public class ElasticsearchCatClient
extends ApiClient<ElasticsearchTransport,ElasticsearchCatClient>

Client for the cat namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class co.elastic.clients.ApiClient

_jsonpMapper, _transport, _transportOptions, getDeserializer, withTransportOptions

Methods inherited from class java.lang.Object

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

Constructor Details

ElasticsearchCatClient

public ElasticsearchCatClient(ElasticsearchTransport transport)

ElasticsearchCatClient

public ElasticsearchCatClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchCatClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchCatClient>

aliases

public AliasesResponse aliases(AliasesRequest request)
                        throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

aliases

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

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

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

aliases

public AliasesResponse aliases()
                        throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

allocation

public AllocationResponse allocation(AllocationRequest request)
                              throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

allocation

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

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

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

allocation

public AllocationResponse allocation()
                              throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

componentTemplates

public ComponentTemplatesResponse componentTemplates(ComponentTemplatesRequest request)
                                              throws IOException,
ElasticsearchException

Returns information about existing component_templates templates.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

componentTemplates

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

Returns information about existing component_templates templates.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

componentTemplates

public ComponentTemplatesResponse componentTemplates()
                                              throws IOException,
ElasticsearchException

Returns information about existing component_templates templates.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

count

public CountResponse count(CountRequest request)
                    throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

count

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

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

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

count

public CountResponse count()
                    throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

fielddata

public FielddataResponse fielddata(FielddataRequest request)
                            throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

fielddata

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

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

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

fielddata

public FielddataResponse fielddata()
                            throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

health

public HealthResponse health(HealthRequest request)
                      throws IOException,
ElasticsearchException

Returns a concise representation of the cluster health.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

health

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

Returns a concise representation of the cluster health.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

health

public HealthResponse health()
                      throws IOException,
ElasticsearchException

Returns a concise representation of the cluster health.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

help

public HelpResponse help()
                  throws IOException,
ElasticsearchException

Returns help for the Cat APIs.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

indices

public IndicesResponse indices(IndicesRequest request)
                        throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

indices

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

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

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

indices

public IndicesResponse indices()
                        throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

master

public MasterResponse master()
                      throws IOException,
ElasticsearchException

Returns information about the master node.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

mlDataFrameAnalytics

public MlDataFrameAnalyticsResponse mlDataFrameAnalytics(MlDataFrameAnalyticsRequest request)
                                                  throws IOException,
ElasticsearchException

Gets configuration and usage information about data frame analytics jobs.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

mlDataFrameAnalytics

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

Gets configuration and usage information about data frame analytics jobs.

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

Gets configuration and usage information about data frame analytics jobs.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

mlDatafeeds

public MlDatafeedsResponse mlDatafeeds(MlDatafeedsRequest request)
                                throws IOException,
ElasticsearchException

Gets configuration and usage information about datafeeds.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

mlDatafeeds

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

Gets configuration and usage information about datafeeds.

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

Gets configuration and usage information about datafeeds.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

mlJobs

public MlJobsResponse mlJobs(MlJobsRequest request)
                      throws IOException,
ElasticsearchException

Gets configuration and usage information about anomaly detection jobs.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

mlJobs

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

Gets configuration and usage information about anomaly detection jobs.

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

Gets configuration and usage information about anomaly detection jobs.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

mlTrainedModels

public MlTrainedModelsResponse mlTrainedModels(MlTrainedModelsRequest request)
                                        throws IOException,
ElasticsearchException

Gets configuration and usage information about inference trained models.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

mlTrainedModels

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

Gets configuration and usage information about inference trained models.

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

Gets configuration and usage information about inference trained models.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

nodeattrs

public NodeattrsResponse nodeattrs()
                            throws IOException,
ElasticsearchException

Returns information about custom node attributes.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

nodes

public NodesResponse nodes(NodesRequest request)
                    throws IOException,
ElasticsearchException

Returns basic statistics about performance of cluster nodes.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

nodes

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

Returns basic statistics about performance of cluster nodes.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

nodes

public NodesResponse nodes()
                    throws IOException,
ElasticsearchException

Returns basic statistics about performance of cluster nodes.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

pendingTasks

public PendingTasksResponse pendingTasks()
                                  throws IOException,
ElasticsearchException

Returns a concise representation of the cluster pending tasks.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

plugins

public PluginsResponse plugins()
                        throws IOException,
ElasticsearchException

Returns information about installed plugins across nodes node.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

recovery

public RecoveryResponse recovery(RecoveryRequest request)
                          throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

recovery

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

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

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

recovery

public RecoveryResponse recovery()
                          throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

repositories

public RepositoriesResponse repositories()
                                  throws IOException,
ElasticsearchException

Returns information about snapshot repositories registered in the cluster.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

segments

public SegmentsResponse segments(SegmentsRequest request)
                          throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

segments

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

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

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

segments

public SegmentsResponse segments()
                          throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

shards

public ShardsResponse shards(ShardsRequest request)
                      throws IOException,
ElasticsearchException

Provides a detailed view of shard allocation on nodes.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

shards

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

Provides a detailed view of shard allocation on nodes.

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

Provides a detailed view of shard allocation on nodes.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

snapshots

public SnapshotsResponse snapshots(SnapshotsRequest request)
                            throws IOException,
ElasticsearchException

Returns all snapshots in a specific repository.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

snapshots

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

Returns all snapshots in a specific repository.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

snapshots

public SnapshotsResponse snapshots()
                            throws IOException,
ElasticsearchException

Returns all snapshots in a specific repository.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

tasks

public TasksResponse tasks(TasksRequest request)
                    throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

tasks

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

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

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

tasks

public TasksResponse tasks()
                    throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

templates

public TemplatesResponse templates(TemplatesRequest request)
                            throws IOException,
ElasticsearchException

Returns information about existing templates.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

templates

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

Returns information about existing templates.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

templates

public TemplatesResponse templates()
                            throws IOException,
ElasticsearchException

Returns information about existing templates.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

threadPool

public ThreadPoolResponse threadPool(ThreadPoolRequest request)
                              throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

threadPool

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

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

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

threadPool

public ThreadPoolResponse threadPool()
                              throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

transforms

public TransformsResponse transforms(TransformsRequest request)
                              throws IOException,
ElasticsearchException

Gets configuration and usage information about transforms.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

transforms

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

Gets configuration and usage information about transforms.

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

Gets configuration and usage information about transforms.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co