Class OpenSearchCatClient
- java.lang.Object
-
- org.opensearch.client.ApiClient<OpenSearchTransport,OpenSearchCatClient>
-
- org.opensearch.client.opensearch.cat.OpenSearchCatClient
-
public class OpenSearchCatClient extends ApiClient<OpenSearchTransport,OpenSearchCatClient>
Client for the cat namespace.
-
-
Field Summary
-
Fields inherited from class org.opensearch.client.ApiClient
transport, transportOptions
-
-
Constructor Summary
Constructors Constructor Description OpenSearchCatClient(OpenSearchTransport transport)OpenSearchCatClient(OpenSearchTransport transport, TransportOptions transportOptions)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description AliasesResponsealiases()Shows information about currently configured aliases to indices including filter and routing infos.AliasesResponsealiases(java.util.function.Function<AliasesRequest.Builder,ObjectBuilder<AliasesRequest>> fn)Shows information about currently configured aliases to indices including filter and routing infos.AliasesResponsealiases(AliasesRequest request)Shows information about currently configured aliases to indices including filter and routing infos.AllocationResponseallocation()Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.AllocationResponseallocation(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.AllocationResponseallocation(AllocationRequest request)Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.ClusterManagerResponseclusterManager()Returns information about the cluster-manager node.CountResponsecount()Provides quick access to the document count of the entire cluster, or individual indices.CountResponsecount(java.util.function.Function<CountRequest.Builder,ObjectBuilder<CountRequest>> fn)Provides quick access to the document count of the entire cluster, or individual indices.CountResponsecount(CountRequest request)Provides quick access to the document count of the entire cluster, or individual indices.FielddataResponsefielddata()Shows how much heap memory is currently being used by fielddata on every data node in the cluster.FielddataResponsefielddata(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.FielddataResponsefielddata(FielddataRequest request)Shows how much heap memory is currently being used by fielddata on every data node in the cluster.HealthResponsehealth()Returns a concise representation of the cluster health.HealthResponsehealth(java.util.function.Function<HealthRequest.Builder,ObjectBuilder<HealthRequest>> fn)Returns a concise representation of the cluster health.HealthResponsehealth(HealthRequest request)Returns a concise representation of the cluster health.HelpResponsehelp()Returns help for the Cat APIs.IndicesResponseindices()Returns information about indices: number of primaries and replicas, document counts, disk size, ...IndicesResponseindices(java.util.function.Function<IndicesRequest.Builder,ObjectBuilder<IndicesRequest>> fn)Returns information about indices: number of primaries and replicas, document counts, disk size, ...IndicesResponseindices(IndicesRequest request)Returns information about indices: number of primaries and replicas, document counts, disk size, ...ClusterManagerResponsemaster()Deprecated.NodeattrsResponsenodeattrs()Returns information about custom node attributes.NodesResponsenodes()Returns basic statistics about performance of cluster nodes.NodesResponsenodes(java.util.function.Function<NodesRequest.Builder,ObjectBuilder<NodesRequest>> fn)Returns basic statistics about performance of cluster nodes.NodesResponsenodes(NodesRequest request)Returns basic statistics about performance of cluster nodes.PendingTasksResponsependingTasks()Returns a concise representation of the cluster pending tasks.SegmentsResponsepitSegments()Provides low-level information about the disk utilization of a PIT by describing its Lucene segments.SegmentsResponsepitSegments(java.util.function.Function<PitSegmentsRequest.Builder,ObjectBuilder<PitSegmentsRequest>> fn)Provides low-level information about the disk utilization of a PIT by describing its Lucene segments.SegmentsResponsepitSegments(PitSegmentsRequest request)Provides low-level information about the disk utilization of a PIT by describing its Lucene segments.PluginsResponseplugins()Returns information about installed plugins across nodes node.RecoveryResponserecovery()Returns information about index shard recoveries, both on-going completed.RecoveryResponserecovery(java.util.function.Function<RecoveryRequest.Builder,ObjectBuilder<RecoveryRequest>> fn)Returns information about index shard recoveries, both on-going completed.RecoveryResponserecovery(RecoveryRequest request)Returns information about index shard recoveries, both on-going completed.RepositoriesResponserepositories()Returns information about snapshot repositories registered in the cluster.SegmentsResponsesegments()Provides low-level information about the segments in the shards of an index.SegmentsResponsesegments(java.util.function.Function<SegmentsRequest.Builder,ObjectBuilder<SegmentsRequest>> fn)Provides low-level information about the segments in the shards of an index.SegmentsResponsesegments(SegmentsRequest request)Provides low-level information about the segments in the shards of an index.ShardsResponseshards()Provides a detailed view of shard allocation on nodes.ShardsResponseshards(java.util.function.Function<ShardsRequest.Builder,ObjectBuilder<ShardsRequest>> fn)Provides a detailed view of shard allocation on nodes.ShardsResponseshards(ShardsRequest request)Provides a detailed view of shard allocation on nodes.SnapshotsResponsesnapshots()Returns all snapshots in a specific repository.SnapshotsResponsesnapshots(java.util.function.Function<SnapshotsRequest.Builder,ObjectBuilder<SnapshotsRequest>> fn)Returns all snapshots in a specific repository.SnapshotsResponsesnapshots(SnapshotsRequest request)Returns all snapshots in a specific repository.TasksResponsetasks()Returns information about the tasks currently executing on one or more nodes in the cluster.TasksResponsetasks(java.util.function.Function<TasksRequest.Builder,ObjectBuilder<TasksRequest>> fn)Returns information about the tasks currently executing on one or more nodes in the cluster.TasksResponsetasks(TasksRequest request)Returns information about the tasks currently executing on one or more nodes in the cluster.TemplatesResponsetemplates()Returns information about existing templates.TemplatesResponsetemplates(java.util.function.Function<TemplatesRequest.Builder,ObjectBuilder<TemplatesRequest>> fn)Returns information about existing templates.TemplatesResponsetemplates(TemplatesRequest request)Returns information about existing templates.ThreadPoolResponsethreadPool()Returns cluster-wide thread pool statistics per node.ThreadPoolResponsethreadPool(java.util.function.Function<ThreadPoolRequest.Builder,ObjectBuilder<ThreadPoolRequest>> fn)Returns cluster-wide thread pool statistics per node.ThreadPoolResponsethreadPool(ThreadPoolRequest request)Returns cluster-wide thread pool statistics per node.OpenSearchCatClientwithTransportOptions(TransportOptions transportOptions)Creates a new client with some request options-
Methods inherited from class org.opensearch.client.ApiClient
_transport, _transportOptions, getDeserializer
-
-
-
-
Constructor Detail
-
OpenSearchCatClient
public OpenSearchCatClient(OpenSearchTransport transport)
-
OpenSearchCatClient
public OpenSearchCatClient(OpenSearchTransport transport, @Nullable TransportOptions transportOptions)
-
-
Method Detail
-
withTransportOptions
public OpenSearchCatClient withTransportOptions(@Nullable TransportOptions transportOptions)
Description copied from class:ApiClientCreates a new client with some request options- Specified by:
withTransportOptionsin classApiClient<OpenSearchTransport,OpenSearchCatClient>
-
aliases
public AliasesResponse aliases(AliasesRequest request) throws java.io.IOException, OpenSearchException
Shows information about currently configured aliases to indices including filter and routing infos.- Throws:
java.io.IOExceptionOpenSearchException
-
aliases
public final AliasesResponse aliases(java.util.function.Function<AliasesRequest.Builder,ObjectBuilder<AliasesRequest>> fn) throws java.io.IOException, OpenSearchException
Shows information about currently configured aliases to indices including filter and routing infos.- Parameters:
fn- a function that initializes a builder to create theAliasesRequest- Throws:
java.io.IOExceptionOpenSearchException
-
aliases
public AliasesResponse aliases() throws java.io.IOException, OpenSearchException
Shows information about currently configured aliases to indices including filter and routing infos.- Throws:
java.io.IOExceptionOpenSearchException
-
allocation
public AllocationResponse allocation(AllocationRequest request) throws java.io.IOException, OpenSearchException
Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.- Throws:
java.io.IOExceptionOpenSearchException
-
allocation
public final AllocationResponse allocation(java.util.function.Function<AllocationRequest.Builder,ObjectBuilder<AllocationRequest>> fn) throws java.io.IOException, OpenSearchException
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 theAllocationRequest- Throws:
java.io.IOExceptionOpenSearchException
-
allocation
public AllocationResponse allocation() throws java.io.IOException, OpenSearchException
Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.- Throws:
java.io.IOExceptionOpenSearchException
-
count
public CountResponse count(CountRequest request) throws java.io.IOException, OpenSearchException
Provides quick access to the document count of the entire cluster, or individual indices.- Throws:
java.io.IOExceptionOpenSearchException
-
count
public final CountResponse count(java.util.function.Function<CountRequest.Builder,ObjectBuilder<CountRequest>> fn) throws java.io.IOException, OpenSearchException
Provides 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:
java.io.IOExceptionOpenSearchException
-
count
public CountResponse count() throws java.io.IOException, OpenSearchException
Provides quick access to the document count of the entire cluster, or individual indices.- Throws:
java.io.IOExceptionOpenSearchException
-
fielddata
public FielddataResponse fielddata(FielddataRequest request) throws java.io.IOException, OpenSearchException
Shows how much heap memory is currently being used by fielddata on every data node in the cluster.- Throws:
java.io.IOExceptionOpenSearchException
-
fielddata
public final FielddataResponse fielddata(java.util.function.Function<FielddataRequest.Builder,ObjectBuilder<FielddataRequest>> fn) throws java.io.IOException, OpenSearchException
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 theFielddataRequest- Throws:
java.io.IOExceptionOpenSearchException
-
fielddata
public FielddataResponse fielddata() throws java.io.IOException, OpenSearchException
Shows how much heap memory is currently being used by fielddata on every data node in the cluster.- Throws:
java.io.IOExceptionOpenSearchException
-
health
public HealthResponse health(HealthRequest request) throws java.io.IOException, OpenSearchException
Returns a concise representation of the cluster health.- Throws:
java.io.IOExceptionOpenSearchException
-
health
public final HealthResponse health(java.util.function.Function<HealthRequest.Builder,ObjectBuilder<HealthRequest>> fn) throws java.io.IOException, OpenSearchException
Returns a concise representation of the cluster health.- Parameters:
fn- a function that initializes a builder to create theHealthRequest- Throws:
java.io.IOExceptionOpenSearchException
-
health
public HealthResponse health() throws java.io.IOException, OpenSearchException
Returns a concise representation of the cluster health.- Throws:
java.io.IOExceptionOpenSearchException
-
help
public HelpResponse help() throws java.io.IOException, OpenSearchException
Returns help for the Cat APIs.- Throws:
java.io.IOExceptionOpenSearchException
-
indices
public IndicesResponse indices(IndicesRequest request) throws java.io.IOException, OpenSearchException
Returns information about indices: number of primaries and replicas, document counts, disk size, ...- Throws:
java.io.IOExceptionOpenSearchException
-
indices
public final IndicesResponse indices(java.util.function.Function<IndicesRequest.Builder,ObjectBuilder<IndicesRequest>> fn) throws java.io.IOException, OpenSearchException
Returns information about indices: number of primaries and replicas, document counts, disk size, ...- Parameters:
fn- a function that initializes a builder to create theIndicesRequest- Throws:
java.io.IOExceptionOpenSearchException
-
indices
public IndicesResponse indices() throws java.io.IOException, OpenSearchException
Returns information about indices: number of primaries and replicas, document counts, disk size, ...- Throws:
java.io.IOExceptionOpenSearchException
-
master
@Deprecated public ClusterManagerResponse master() throws java.io.IOException, OpenSearchException
Deprecated.Returns information about the master node.- Throws:
java.io.IOExceptionOpenSearchException
-
clusterManager
public ClusterManagerResponse clusterManager() throws java.io.IOException, OpenSearchException
Returns information about the cluster-manager node.- Throws:
java.io.IOExceptionOpenSearchException
-
nodeattrs
public NodeattrsResponse nodeattrs() throws java.io.IOException, OpenSearchException
Returns information about custom node attributes.- Throws:
java.io.IOExceptionOpenSearchException
-
nodes
public NodesResponse nodes(NodesRequest request) throws java.io.IOException, OpenSearchException
Returns basic statistics about performance of cluster nodes.- Throws:
java.io.IOExceptionOpenSearchException
-
nodes
public final NodesResponse nodes(java.util.function.Function<NodesRequest.Builder,ObjectBuilder<NodesRequest>> fn) throws java.io.IOException, OpenSearchException
Returns basic statistics about performance of cluster nodes.- Parameters:
fn- a function that initializes a builder to create theNodesRequest- Throws:
java.io.IOExceptionOpenSearchException
-
nodes
public NodesResponse nodes() throws java.io.IOException, OpenSearchException
Returns basic statistics about performance of cluster nodes.- Throws:
java.io.IOExceptionOpenSearchException
-
pitSegments
public SegmentsResponse pitSegments(PitSegmentsRequest request) throws java.io.IOException, OpenSearchException
Provides low-level information about the disk utilization of a PIT by describing its Lucene segments.- Throws:
java.io.IOExceptionOpenSearchException
-
pitSegments
public final SegmentsResponse pitSegments(java.util.function.Function<PitSegmentsRequest.Builder,ObjectBuilder<PitSegmentsRequest>> fn) throws java.io.IOException, OpenSearchException
Provides low-level information about the disk utilization of a PIT by describing its Lucene segments. * @param fn a function that initializes a builder to create thePitSegmentsRequest- Throws:
java.io.IOExceptionOpenSearchException
-
pitSegments
public SegmentsResponse pitSegments() throws java.io.IOException, OpenSearchException
Provides low-level information about the disk utilization of a PIT by describing its Lucene segments.- Throws:
java.io.IOExceptionOpenSearchException
-
pendingTasks
public PendingTasksResponse pendingTasks() throws java.io.IOException, OpenSearchException
Returns a concise representation of the cluster pending tasks.- Throws:
java.io.IOExceptionOpenSearchException
-
plugins
public PluginsResponse plugins() throws java.io.IOException, OpenSearchException
Returns information about installed plugins across nodes node.- Throws:
java.io.IOExceptionOpenSearchException
-
recovery
public RecoveryResponse recovery(RecoveryRequest request) throws java.io.IOException, OpenSearchException
Returns information about index shard recoveries, both on-going completed.- Throws:
java.io.IOExceptionOpenSearchException
-
recovery
public final RecoveryResponse recovery(java.util.function.Function<RecoveryRequest.Builder,ObjectBuilder<RecoveryRequest>> fn) throws java.io.IOException, OpenSearchException
Returns information about index shard recoveries, both on-going completed.- Parameters:
fn- a function that initializes a builder to create theRecoveryRequest- Throws:
java.io.IOExceptionOpenSearchException
-
recovery
public RecoveryResponse recovery() throws java.io.IOException, OpenSearchException
Returns information about index shard recoveries, both on-going completed.- Throws:
java.io.IOExceptionOpenSearchException
-
repositories
public RepositoriesResponse repositories() throws java.io.IOException, OpenSearchException
Returns information about snapshot repositories registered in the cluster.- Throws:
java.io.IOExceptionOpenSearchException
-
segments
public SegmentsResponse segments(SegmentsRequest request) throws java.io.IOException, OpenSearchException
Provides low-level information about the segments in the shards of an index.- Throws:
java.io.IOExceptionOpenSearchException
-
segments
public final SegmentsResponse segments(java.util.function.Function<SegmentsRequest.Builder,ObjectBuilder<SegmentsRequest>> fn) throws java.io.IOException, OpenSearchException
Provides low-level information about the segments in the shards of an index.- Parameters:
fn- a function that initializes a builder to create theSegmentsRequest- Throws:
java.io.IOExceptionOpenSearchException
-
segments
public SegmentsResponse segments() throws java.io.IOException, OpenSearchException
Provides low-level information about the segments in the shards of an index.- Throws:
java.io.IOExceptionOpenSearchException
-
shards
public ShardsResponse shards(ShardsRequest request) throws java.io.IOException, OpenSearchException
Provides a detailed view of shard allocation on nodes.- Throws:
java.io.IOExceptionOpenSearchException
-
shards
public final ShardsResponse shards(java.util.function.Function<ShardsRequest.Builder,ObjectBuilder<ShardsRequest>> fn) throws java.io.IOException, OpenSearchException
Provides a detailed view of shard allocation on nodes.- Parameters:
fn- a function that initializes a builder to create theShardsRequest- Throws:
java.io.IOExceptionOpenSearchException
-
shards
public ShardsResponse shards() throws java.io.IOException, OpenSearchException
Provides a detailed view of shard allocation on nodes.- Throws:
java.io.IOExceptionOpenSearchException
-
snapshots
public SnapshotsResponse snapshots(SnapshotsRequest request) throws java.io.IOException, OpenSearchException
Returns all snapshots in a specific repository.- Throws:
java.io.IOExceptionOpenSearchException
-
snapshots
public final SnapshotsResponse snapshots(java.util.function.Function<SnapshotsRequest.Builder,ObjectBuilder<SnapshotsRequest>> fn) throws java.io.IOException, OpenSearchException
Returns all snapshots in a specific repository.- Parameters:
fn- a function that initializes a builder to create theSnapshotsRequest- Throws:
java.io.IOExceptionOpenSearchException
-
snapshots
public SnapshotsResponse snapshots() throws java.io.IOException, OpenSearchException
Returns all snapshots in a specific repository.- Throws:
java.io.IOExceptionOpenSearchException
-
tasks
public TasksResponse tasks(TasksRequest request) throws java.io.IOException, OpenSearchException
Returns information about the tasks currently executing on one or more nodes in the cluster.- Throws:
java.io.IOExceptionOpenSearchException
-
tasks
public final TasksResponse tasks(java.util.function.Function<TasksRequest.Builder,ObjectBuilder<TasksRequest>> fn) throws java.io.IOException, OpenSearchException
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 theTasksRequest- Throws:
java.io.IOExceptionOpenSearchException
-
tasks
public TasksResponse tasks() throws java.io.IOException, OpenSearchException
Returns information about the tasks currently executing on one or more nodes in the cluster.- Throws:
java.io.IOExceptionOpenSearchException
-
templates
public TemplatesResponse templates(TemplatesRequest request) throws java.io.IOException, OpenSearchException
Returns information about existing templates.- Throws:
java.io.IOExceptionOpenSearchException
-
templates
public final TemplatesResponse templates(java.util.function.Function<TemplatesRequest.Builder,ObjectBuilder<TemplatesRequest>> fn) throws java.io.IOException, OpenSearchException
Returns information about existing templates.- Parameters:
fn- a function that initializes a builder to create theTemplatesRequest- Throws:
java.io.IOExceptionOpenSearchException
-
templates
public TemplatesResponse templates() throws java.io.IOException, OpenSearchException
Returns information about existing templates.- Throws:
java.io.IOExceptionOpenSearchException
-
threadPool
public ThreadPoolResponse threadPool(ThreadPoolRequest request) throws java.io.IOException, OpenSearchException
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.IOExceptionOpenSearchException
-
threadPool
public final ThreadPoolResponse threadPool(java.util.function.Function<ThreadPoolRequest.Builder,ObjectBuilder<ThreadPoolRequest>> fn) throws java.io.IOException, OpenSearchException
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 theThreadPoolRequest- Throws:
java.io.IOExceptionOpenSearchException
-
threadPool
public ThreadPoolResponse threadPool() throws java.io.IOException, OpenSearchException
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.IOExceptionOpenSearchException
-
-