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
ConstructorDescriptionElasticsearchCatClient
(ElasticsearchTransport transport) ElasticsearchCatClient
(ElasticsearchTransport transport, TransportOptions transportOptions) -
Method Summary
Modifier and TypeMethodDescriptionaliases()
Shows information about currently configured aliases to indices including filter and routing infos.aliases
(AliasesRequest request) Shows information about currently configured aliases to indices including filter and routing infos.final AliasesResponse
Shows information about currently configured aliases to indices including filter and routing infos.Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.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
Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.count()
Provides quick access to the document count of the entire cluster, or individual indices.count
(CountRequest request) Provides quick access to the document count of the entire cluster, or individual indices.final CountResponse
Provides quick access to the document count of the entire cluster, or individual indices.Shows how much heap memory is currently being used by fielddata on every data node in the cluster.fielddata
(FielddataRequest request) Shows how much heap memory is currently being used by fielddata on every data node in the cluster.final FielddataResponse
Shows how much heap memory is currently being used by fielddata on every data node in the cluster.health()
Returns a concise representation of the cluster health.health
(HealthRequest request) Returns a concise representation of the cluster health.final HealthResponse
Returns a concise representation of the cluster health.help()
Returns help for the Cat APIs.indices()
Returns information about indices: number of primaries and replicas, document counts, disk size, ...indices
(IndicesRequest request) Returns information about indices: number of primaries and replicas, document counts, disk size, ...final IndicesResponse
Returns information about indices: number of primaries and replicas, document counts, disk size, ...master()
Returns information about the master node.Gets configuration and usage information about datafeeds.mlDatafeeds
(MlDatafeedsRequest request) Gets configuration and usage information about datafeeds.final MlDatafeedsResponse
Gets configuration and usage information about datafeeds.Gets configuration and usage information about data frame analytics jobs.Gets configuration and usage information about data frame analytics jobs.mlDataFrameAnalytics
(Function<MlDataFrameAnalyticsRequest.Builder, ObjectBuilder<MlDataFrameAnalyticsRequest>> fn) Gets configuration and usage information about data frame analytics jobs.mlJobs()
Gets configuration and usage information about anomaly detection jobs.mlJobs
(MlJobsRequest request) Gets configuration and usage information about anomaly detection jobs.final MlJobsResponse
Gets configuration and usage information about anomaly detection jobs.Gets configuration and usage information about inference trained models.mlTrainedModels
(MlTrainedModelsRequest request) Gets configuration and usage information about inference trained models.final MlTrainedModelsResponse
Gets configuration and usage information about inference trained models.Returns information about custom node attributes.nodes()
Returns basic statistics about performance of cluster nodes.nodes
(NodesRequest request) Returns basic statistics about performance of cluster nodes.final NodesResponse
Returns basic statistics about performance of cluster nodes.Returns a concise representation of the cluster pending tasks.plugins()
Returns information about installed plugins across nodes node.recovery()
Returns information about index shard recoveries, both on-going completed.recovery
(RecoveryRequest request) Returns information about index shard recoveries, both on-going completed.final RecoveryResponse
Returns information about index shard recoveries, both on-going completed.Returns information about snapshot repositories registered in the cluster.segments()
Provides low-level information about the segments in the shards of an index.segments
(SegmentsRequest request) Provides low-level information about the segments in the shards of an index.final SegmentsResponse
Provides low-level information about the segments in the shards of an index.shards()
Provides a detailed view of shard allocation on nodes.shards
(ShardsRequest request) Provides a detailed view of shard allocation on nodes.final ShardsResponse
Provides a detailed view of shard allocation on nodes.Returns all snapshots in a specific repository.snapshots
(SnapshotsRequest request) Returns all snapshots in a specific repository.final SnapshotsResponse
Returns all snapshots in a specific repository.tasks()
Returns information about the tasks currently executing on one or more nodes in the cluster.tasks
(TasksRequest request) Returns information about the tasks currently executing on one or more nodes in the cluster.final TasksResponse
Returns information about the tasks currently executing on one or more nodes in the cluster.Returns information about existing templates.templates
(TemplatesRequest request) Returns information about existing templates.final TemplatesResponse
Returns information about existing templates.Returns cluster-wide thread pool statistics per node.threadPool
(ThreadPoolRequest request) Returns cluster-wide thread pool statistics per node.final ThreadPoolResponse
Returns cluster-wide thread pool statistics per node.Gets configuration and usage information about transforms.transforms
(TransformsRequest request) Gets configuration and usage information about transforms.final TransformsResponse
Gets configuration and usage information about transforms.withTransportOptions
(TransportOptions transportOptions) Creates a new client with some request optionsMethods inherited from class co.elastic.clients.ApiClient
_jsonpMapper, _transport, _transportOptions, getDeserializer, withTransportOptions
-
Constructor Details
-
ElasticsearchCatClient
-
ElasticsearchCatClient
public ElasticsearchCatClient(ElasticsearchTransport transport, @Nullable TransportOptions transportOptions)
-
-
Method Details
-
withTransportOptions
Description copied from class:ApiClient
Creates a new client with some request options- Specified by:
withTransportOptions
in classApiClient<ElasticsearchTransport,
ElasticsearchCatClient>
-
aliases
Shows information about currently configured aliases to indices including filter and routing infos.- Throws:
IOException
ElasticsearchException
- See Also:
-
aliases
public final AliasesResponse aliases(Function<AliasesRequest.Builder, ObjectBuilder<AliasesRequest>> fn) throws IOException, ElasticsearchExceptionShows information about currently configured aliases to indices including filter and routing infos.- Parameters:
fn
- a function that initializes a builder to create theAliasesRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
aliases
Shows information about currently configured aliases to indices including filter and routing infos.- Throws:
IOException
ElasticsearchException
- See Also:
-
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:
-
allocation
public final AllocationResponse allocation(Function<AllocationRequest.Builder, ObjectBuilder<AllocationRequest>> fn) throws IOException, ElasticsearchExceptionProvides 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 theAllocationRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
allocation
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:
-
count
Provides quick access to the document count of the entire cluster, or individual indices.- Throws:
IOException
ElasticsearchException
- See Also:
-
count
public final CountResponse count(Function<CountRequest.Builder, ObjectBuilder<CountRequest>> fn) throws IOException, ElasticsearchExceptionProvides quick access to the document count of the entire cluster, or individual indices.- Parameters:
fn
- a function that initializes a builder to create theCountRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
count
Provides quick access to the document count of the entire cluster, or individual indices.- Throws:
IOException
ElasticsearchException
- See Also:
-
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:
-
fielddata
public final FielddataResponse fielddata(Function<FielddataRequest.Builder, ObjectBuilder<FielddataRequest>> fn) throws IOException, ElasticsearchExceptionShows 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 theFielddataRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
fielddata
Shows how much heap memory is currently being used by fielddata on every data node in the cluster.- Throws:
IOException
ElasticsearchException
- See Also:
-
health
Returns a concise representation of the cluster health.- Throws:
IOException
ElasticsearchException
- See Also:
-
health
public final HealthResponse health(Function<HealthRequest.Builder, ObjectBuilder<HealthRequest>> fn) throws IOException, ElasticsearchExceptionReturns a concise representation of the cluster health.- Parameters:
fn
- a function that initializes a builder to create theHealthRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
health
Returns a concise representation of the cluster health.- Throws:
IOException
ElasticsearchException
- See Also:
-
help
Returns help for the Cat APIs.- Throws:
IOException
ElasticsearchException
- See Also:
-
indices
Returns information about indices: number of primaries and replicas, document counts, disk size, ...- Throws:
IOException
ElasticsearchException
- See Also:
-
indices
public final IndicesResponse indices(Function<IndicesRequest.Builder, ObjectBuilder<IndicesRequest>> fn) throws IOException, ElasticsearchExceptionReturns information about indices: number of primaries and replicas, document counts, disk size, ...- Parameters:
fn
- a function that initializes a builder to create theIndicesRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
indices
Returns information about indices: number of primaries and replicas, document counts, disk size, ...- Throws:
IOException
ElasticsearchException
- See Also:
-
master
Returns information about the master node.- Throws:
IOException
ElasticsearchException
- See Also:
-
mlDataFrameAnalytics
public MlDataFrameAnalyticsResponse mlDataFrameAnalytics(MlDataFrameAnalyticsRequest request) throws IOException, ElasticsearchException Gets configuration and usage information about data frame analytics jobs.- Throws:
IOException
ElasticsearchException
- See Also:
-
mlDataFrameAnalytics
public final MlDataFrameAnalyticsResponse mlDataFrameAnalytics(Function<MlDataFrameAnalyticsRequest.Builder, ObjectBuilder<MlDataFrameAnalyticsRequest>> fn) throws IOException, ElasticsearchExceptionGets configuration and usage information about data frame analytics jobs.- Parameters:
fn
- a function that initializes a builder to create theMlDataFrameAnalyticsRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
mlDataFrameAnalytics
public MlDataFrameAnalyticsResponse mlDataFrameAnalytics() throws IOException, ElasticsearchExceptionGets configuration and usage information about data frame analytics jobs.- Throws:
IOException
ElasticsearchException
- See Also:
-
mlDatafeeds
public MlDatafeedsResponse mlDatafeeds(MlDatafeedsRequest request) throws IOException, ElasticsearchException Gets configuration and usage information about datafeeds.- Throws:
IOException
ElasticsearchException
- See Also:
-
mlDatafeeds
public final MlDatafeedsResponse mlDatafeeds(Function<MlDatafeedsRequest.Builder, ObjectBuilder<MlDatafeedsRequest>> fn) throws IOException, ElasticsearchExceptionGets configuration and usage information about datafeeds.- Parameters:
fn
- a function that initializes a builder to create theMlDatafeedsRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
mlDatafeeds
Gets configuration and usage information about datafeeds.- Throws:
IOException
ElasticsearchException
- See Also:
-
mlJobs
Gets configuration and usage information about anomaly detection jobs.- Throws:
IOException
ElasticsearchException
- See Also:
-
mlJobs
public final MlJobsResponse mlJobs(Function<MlJobsRequest.Builder, ObjectBuilder<MlJobsRequest>> fn) throws IOException, ElasticsearchExceptionGets configuration and usage information about anomaly detection jobs.- Parameters:
fn
- a function that initializes a builder to create theMlJobsRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
mlJobs
Gets configuration and usage information about anomaly detection jobs.- Throws:
IOException
ElasticsearchException
- See Also:
-
mlTrainedModels
public MlTrainedModelsResponse mlTrainedModels(MlTrainedModelsRequest request) throws IOException, ElasticsearchException Gets configuration and usage information about inference trained models.- Throws:
IOException
ElasticsearchException
- See Also:
-
mlTrainedModels
public final MlTrainedModelsResponse mlTrainedModels(Function<MlTrainedModelsRequest.Builder, ObjectBuilder<MlTrainedModelsRequest>> fn) throws IOException, ElasticsearchExceptionGets configuration and usage information about inference trained models.- Parameters:
fn
- a function that initializes a builder to create theMlTrainedModelsRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
mlTrainedModels
Gets configuration and usage information about inference trained models.- Throws:
IOException
ElasticsearchException
- See Also:
-
nodeattrs
Returns information about custom node attributes.- Throws:
IOException
ElasticsearchException
- See Also:
-
nodes
Returns basic statistics about performance of cluster nodes.- Throws:
IOException
ElasticsearchException
- See Also:
-
nodes
public final NodesResponse nodes(Function<NodesRequest.Builder, ObjectBuilder<NodesRequest>> fn) throws IOException, ElasticsearchExceptionReturns basic statistics about performance of cluster nodes.- Parameters:
fn
- a function that initializes a builder to create theNodesRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
nodes
Returns basic statistics about performance of cluster nodes.- Throws:
IOException
ElasticsearchException
- See Also:
-
pendingTasks
Returns a concise representation of the cluster pending tasks.- Throws:
IOException
ElasticsearchException
- See Also:
-
plugins
Returns information about installed plugins across nodes node.- Throws:
IOException
ElasticsearchException
- See Also:
-
recovery
public RecoveryResponse recovery(RecoveryRequest request) throws IOException, ElasticsearchException Returns information about index shard recoveries, both on-going completed.- Throws:
IOException
ElasticsearchException
- See Also:
-
recovery
public final RecoveryResponse recovery(Function<RecoveryRequest.Builder, ObjectBuilder<RecoveryRequest>> fn) throws IOException, ElasticsearchExceptionReturns information about index shard recoveries, both on-going completed.- Parameters:
fn
- a function that initializes a builder to create theRecoveryRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
recovery
Returns information about index shard recoveries, both on-going completed.- Throws:
IOException
ElasticsearchException
- See Also:
-
repositories
Returns information about snapshot repositories registered in the cluster.- Throws:
IOException
ElasticsearchException
- See Also:
-
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:
-
segments
public final SegmentsResponse segments(Function<SegmentsRequest.Builder, ObjectBuilder<SegmentsRequest>> fn) throws IOException, ElasticsearchExceptionProvides low-level information about the segments in the shards of an index.- Parameters:
fn
- a function that initializes a builder to create theSegmentsRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
segments
Provides low-level information about the segments in the shards of an index.- Throws:
IOException
ElasticsearchException
- See Also:
-
shards
Provides a detailed view of shard allocation on nodes.- Throws:
IOException
ElasticsearchException
- See Also:
-
shards
public final ShardsResponse shards(Function<ShardsRequest.Builder, ObjectBuilder<ShardsRequest>> fn) throws IOException, ElasticsearchExceptionProvides a detailed view of shard allocation on nodes.- Parameters:
fn
- a function that initializes a builder to create theShardsRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
shards
Provides a detailed view of shard allocation on nodes.- Throws:
IOException
ElasticsearchException
- See Also:
-
snapshots
public SnapshotsResponse snapshots(SnapshotsRequest request) throws IOException, ElasticsearchException Returns all snapshots in a specific repository.- Throws:
IOException
ElasticsearchException
- See Also:
-
snapshots
public final SnapshotsResponse snapshots(Function<SnapshotsRequest.Builder, ObjectBuilder<SnapshotsRequest>> fn) throws IOException, ElasticsearchExceptionReturns all snapshots in a specific repository.- Parameters:
fn
- a function that initializes a builder to create theSnapshotsRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
snapshots
Returns all snapshots in a specific repository.- Throws:
IOException
ElasticsearchException
- See Also:
-
tasks
Returns information about the tasks currently executing on one or more nodes in the cluster.- Throws:
IOException
ElasticsearchException
- See Also:
-
tasks
public final TasksResponse tasks(Function<TasksRequest.Builder, ObjectBuilder<TasksRequest>> fn) throws IOException, ElasticsearchExceptionReturns information about the tasks currently executing on one or more nodes in the cluster.- Parameters:
fn
- a function that initializes a builder to create theTasksRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
tasks
Returns information about the tasks currently executing on one or more nodes in the cluster.- Throws:
IOException
ElasticsearchException
- See Also:
-
templates
public TemplatesResponse templates(TemplatesRequest request) throws IOException, ElasticsearchException Returns information about existing templates.- Throws:
IOException
ElasticsearchException
- See Also:
-
templates
public final TemplatesResponse templates(Function<TemplatesRequest.Builder, ObjectBuilder<TemplatesRequest>> fn) throws IOException, ElasticsearchExceptionReturns information about existing templates.- Parameters:
fn
- a function that initializes a builder to create theTemplatesRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
templates
Returns information about existing templates.- Throws:
IOException
ElasticsearchException
- See Also:
-
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:
-
threadPool
public final ThreadPoolResponse threadPool(Function<ThreadPoolRequest.Builder, ObjectBuilder<ThreadPoolRequest>> fn) throws IOException, ElasticsearchExceptionReturns 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 theThreadPoolRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
threadPool
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:
-
transforms
public TransformsResponse transforms(TransformsRequest request) throws IOException, ElasticsearchException Gets configuration and usage information about transforms.- Throws:
IOException
ElasticsearchException
- See Also:
-
transforms
public final TransformsResponse transforms(Function<TransformsRequest.Builder, ObjectBuilder<TransformsRequest>> fn) throws IOException, ElasticsearchExceptionGets configuration and usage information about transforms.- Parameters:
fn
- a function that initializes a builder to create theTransformsRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
transforms
Gets configuration and usage information about transforms.- Throws:
IOException
ElasticsearchException
- See Also:
-