Class OpenSearchCatAsyncClientBase<Self extends OpenSearchCatAsyncClientBase<Self>>
java.lang.Object
org.opensearch.client.ApiClient<OpenSearchTransport,Self>
org.opensearch.client.opensearch.cat.OpenSearchCatAsyncClientBase<Self>
- Direct Known Subclasses:
OpenSearchCatAsyncClient
@Generated("org.opensearch.client.codegen.CodeGenerator")
public abstract class OpenSearchCatAsyncClientBase<Self extends OpenSearchCatAsyncClientBase<Self>>
extends ApiClient<OpenSearchTransport,Self>
Client for the cat namespace.
-
Field Summary
Fields inherited from class org.opensearch.client.ApiClient
transport, transportOptions -
Constructor Summary
ConstructorsConstructorDescriptionOpenSearchCatAsyncClientBase(OpenSearchTransport transport, TransportOptions transportOptions) -
Method Summary
Modifier and TypeMethodDescriptionfinal CompletableFuture<AliasesResponse> aliases()Shows information about aliases currently configured to indexes, including filter and routing information.final CompletableFuture<AliasesResponse> Shows information about aliases currently configured to indexes, including filter and routing information.aliases(AliasesRequest request) Shows information about aliases currently configured to indexes, including filter and routing information.Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.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.Lists all active CAT point-in-time segments.Lists all active CAT point-in-time segments.allPitSegments(AllPitSegmentsRequest request) Lists all active CAT point-in-time segments.Returns information about the cluster-manager node.Returns information about the cluster-manager node.clusterManager(ClusterManagerRequest request) Returns information about the cluster-manager node.final CompletableFuture<CountResponse> count()Provides quick access to the document count of the entire cluster or of an individual index.final CompletableFuture<CountResponse> Provides quick access to the document count of the entire cluster or of an individual index.count(CountRequest request) Provides quick access to the document count of the entire cluster or of an individual index.Shows how much heap memory is currently being used by field data on every data node in the cluster.Shows how much heap memory is currently being used by field data on every data node in the cluster.fielddata(FielddataRequest request) Shows how much heap memory is currently being used by field data on every data node in the cluster.final CompletableFuture<HealthResponse> health()Returns a concise representation of the cluster health.final CompletableFuture<HealthResponse> Returns a concise representation of the cluster health.health(HealthRequest request) Returns a concise representation of the cluster health.final CompletableFuture<IndicesResponse> indices()Lists information related to indexes, that is, how much disk space they are using, how many shards they have, their health status, and so on.final CompletableFuture<IndicesResponse> Lists information related to indexes, that is, how much disk space they are using, how many shards they have, their health status, and so on.indices(IndicesRequest request) Lists information related to indexes, that is, how much disk space they are using, how many shards they have, their health status, and so on.final CompletableFuture<MasterResponse> master()Deprecated.final CompletableFuture<MasterResponse> Deprecated.master(MasterRequest request) Deprecated.Returns information about custom node attributes.Returns information about custom node attributes.nodeattrs(NodeattrsRequest request) Returns information about custom node attributes.final CompletableFuture<NodesResponse> nodes()Returns basic statistics about the performance of cluster nodes.final CompletableFuture<NodesResponse> Returns basic statistics about the performance of cluster nodes.nodes(NodesRequest request) Returns basic statistics about the performance of cluster nodes.Returns a concise representation of the cluster's pending tasks.Returns a concise representation of the cluster's pending tasks.pendingTasks(PendingTasksRequest request) Returns a concise representation of the cluster's pending tasks.Lists one or several CAT point-in-time segments.pitSegments(PitSegmentsRequest request) Lists one or several CAT point-in-time segments.final CompletableFuture<PluginsResponse> plugins()Returns information about the names, components, and versions of the installed plugins.final CompletableFuture<PluginsResponse> Returns information about the names, components, and versions of the installed plugins.plugins(PluginsRequest request) Returns information about the names, components, and versions of the installed plugins.recovery()Returns all completed and ongoing index and shard recoveries.Returns all completed and ongoing index and shard recoveries.recovery(RecoveryRequest request) Returns all completed and ongoing index and shard recoveries.Returns information about all snapshot repositories for a cluster.Returns information about all snapshot repositories for a cluster.repositories(RepositoriesRequest request) Returns information about all snapshot repositories for a cluster.Returns information about active and last-completed segment replication events on each replica shard, including related shard-level metrics.segmentReplication(Function<SegmentReplicationRequest.Builder, ObjectBuilder<SegmentReplicationRequest>> fn) Returns information about active and last-completed segment replication events on each replica shard, including related shard-level metrics.Returns information about active and last-completed segment replication events on each replica shard, including related shard-level metrics.segments()Provides low-level information about the segments in the shards of an index.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 CompletableFuture<ShardsResponse> shards()Lists the states of all primary and replica shards and how they are distributed.final CompletableFuture<ShardsResponse> Lists the states of all primary and replica shards and how they are distributed.shards(ShardsRequest request) Lists the states of all primary and replica shards and how they are distributed.Lists all of the snapshots stored in a specific repository.Lists all of the snapshots stored in a specific repository.snapshots(SnapshotsRequest request) Lists all of the snapshots stored in a specific repository.final CompletableFuture<TasksResponse> tasks()Lists the progress of all tasks currently running on the cluster.final CompletableFuture<TasksResponse> Lists the progress of all tasks currently running on the cluster.tasks(TasksRequest request) Lists the progress of all tasks currently running on the cluster.Lists the names, patterns, order numbers, and version numbers of index templates.Lists the names, patterns, order numbers, and version numbers of index templates.templates(TemplatesRequest request) Lists the names, patterns, order numbers, and version numbers of index templates.Returns cluster-wide thread pool statistics per node.Returns cluster-wide thread pool statistics per node.threadPool(ThreadPoolRequest request) Returns cluster-wide thread pool statistics per node.Methods inherited from class org.opensearch.client.ApiClient
_transport, _transportOptions, getDeserializer, withTransportOptions
-
Constructor Details
-
OpenSearchCatAsyncClientBase
public OpenSearchCatAsyncClientBase(OpenSearchTransport transport, @Nullable TransportOptions transportOptions)
-
-
Method Details
-
aliases
public CompletableFuture<AliasesResponse> aliases(AliasesRequest request) throws IOException, OpenSearchException Shows information about aliases currently configured to indexes, including filter and routing information.- Throws:
IOExceptionOpenSearchException
-
aliases
public final CompletableFuture<AliasesResponse> aliases(Function<AliasesRequest.Builder, ObjectBuilder<AliasesRequest>> fn) throws IOException, OpenSearchExceptionShows information about aliases currently configured to indexes, including filter and routing information.- Parameters:
fn- a function that initializes a builder to create theAliasesRequest- Throws:
IOExceptionOpenSearchException
-
aliases
Shows information about aliases currently configured to indexes, including filter and routing information.- Throws:
IOExceptionOpenSearchException
-
allPitSegments
public CompletableFuture<AllPitSegmentsResponse> allPitSegments(AllPitSegmentsRequest request) throws IOException, OpenSearchException Lists all active CAT point-in-time segments.- Throws:
IOExceptionOpenSearchException
-
allPitSegments
public final CompletableFuture<AllPitSegmentsResponse> allPitSegments(Function<AllPitSegmentsRequest.Builder, ObjectBuilder<AllPitSegmentsRequest>> fn) throws IOException, OpenSearchExceptionLists all active CAT point-in-time segments.- Parameters:
fn- a function that initializes a builder to create theAllPitSegmentsRequest- Throws:
IOExceptionOpenSearchException
-
allPitSegments
public final CompletableFuture<AllPitSegmentsResponse> allPitSegments() throws IOException, OpenSearchExceptionLists all active CAT point-in-time segments.- Throws:
IOExceptionOpenSearchException
-
allocation
public CompletableFuture<AllocationResponse> allocation(AllocationRequest request) throws IOException, OpenSearchException Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.- Throws:
IOExceptionOpenSearchException
-
allocation
public final CompletableFuture<AllocationResponse> allocation(Function<AllocationRequest.Builder, ObjectBuilder<AllocationRequest>> fn) throws IOException, OpenSearchExceptionProvides 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:
IOExceptionOpenSearchException
-
allocation
public final CompletableFuture<AllocationResponse> allocation() throws IOException, OpenSearchExceptionProvides a snapshot of how many shards are allocated to each data node and how much disk space they are using.- Throws:
IOExceptionOpenSearchException
-
clusterManager
public CompletableFuture<ClusterManagerResponse> clusterManager(ClusterManagerRequest request) throws IOException, OpenSearchException Returns information about the cluster-manager node.- Throws:
IOExceptionOpenSearchException
-
clusterManager
public final CompletableFuture<ClusterManagerResponse> clusterManager(Function<ClusterManagerRequest.Builder, ObjectBuilder<ClusterManagerRequest>> fn) throws IOException, OpenSearchExceptionReturns information about the cluster-manager node.- Parameters:
fn- a function that initializes a builder to create theClusterManagerRequest- Throws:
IOExceptionOpenSearchException
-
clusterManager
public final CompletableFuture<ClusterManagerResponse> clusterManager() throws IOException, OpenSearchExceptionReturns information about the cluster-manager node.- Throws:
IOExceptionOpenSearchException
-
count
public CompletableFuture<CountResponse> count(CountRequest request) throws IOException, OpenSearchException Provides quick access to the document count of the entire cluster or of an individual index.- Throws:
IOExceptionOpenSearchException
-
count
public final CompletableFuture<CountResponse> count(Function<CountRequest.Builder, ObjectBuilder<CountRequest>> fn) throws IOException, OpenSearchExceptionProvides quick access to the document count of the entire cluster or of an individual index.- Parameters:
fn- a function that initializes a builder to create theCountRequest- Throws:
IOExceptionOpenSearchException
-
count
Provides quick access to the document count of the entire cluster or of an individual index.- Throws:
IOExceptionOpenSearchException
-
fielddata
public CompletableFuture<FielddataResponse> fielddata(FielddataRequest request) throws IOException, OpenSearchException Shows how much heap memory is currently being used by field data on every data node in the cluster.- Throws:
IOExceptionOpenSearchException
-
fielddata
public final CompletableFuture<FielddataResponse> fielddata(Function<FielddataRequest.Builder, ObjectBuilder<FielddataRequest>> fn) throws IOException, OpenSearchExceptionShows how much heap memory is currently being used by field data on every data node in the cluster.- Parameters:
fn- a function that initializes a builder to create theFielddataRequest- Throws:
IOExceptionOpenSearchException
-
fielddata
public final CompletableFuture<FielddataResponse> fielddata() throws IOException, OpenSearchExceptionShows how much heap memory is currently being used by field data on every data node in the cluster.- Throws:
IOExceptionOpenSearchException
-
health
public CompletableFuture<HealthResponse> health(HealthRequest request) throws IOException, OpenSearchException Returns a concise representation of the cluster health.- Throws:
IOExceptionOpenSearchException
-
health
public final CompletableFuture<HealthResponse> health(Function<HealthRequest.Builder, ObjectBuilder<HealthRequest>> fn) throws IOException, OpenSearchExceptionReturns a concise representation of the cluster health.- Parameters:
fn- a function that initializes a builder to create theHealthRequest- Throws:
IOExceptionOpenSearchException
-
health
Returns a concise representation of the cluster health.- Throws:
IOExceptionOpenSearchException
-
indices
public CompletableFuture<IndicesResponse> indices(IndicesRequest request) throws IOException, OpenSearchException Lists information related to indexes, that is, how much disk space they are using, how many shards they have, their health status, and so on.- Throws:
IOExceptionOpenSearchException
-
indices
public final CompletableFuture<IndicesResponse> indices(Function<IndicesRequest.Builder, ObjectBuilder<IndicesRequest>> fn) throws IOException, OpenSearchExceptionLists information related to indexes, that is, how much disk space they are using, how many shards they have, their health status, and so on.- Parameters:
fn- a function that initializes a builder to create theIndicesRequest- Throws:
IOExceptionOpenSearchException
-
indices
Lists information related to indexes, that is, how much disk space they are using, how many shards they have, their health status, and so on.- Throws:
IOExceptionOpenSearchException
-
master
@Deprecated public CompletableFuture<MasterResponse> master(MasterRequest request) throws IOException, OpenSearchException Deprecated.Returns information about the cluster-manager node.- Throws:
IOExceptionOpenSearchException
-
master
@Deprecated public final CompletableFuture<MasterResponse> master(Function<MasterRequest.Builder, ObjectBuilder<MasterRequest>> fn) throws IOException, OpenSearchExceptionDeprecated.Returns information about the cluster-manager node.- Parameters:
fn- a function that initializes a builder to create theMasterRequest- Throws:
IOExceptionOpenSearchException
-
master
@Deprecated public final CompletableFuture<MasterResponse> master() throws IOException, OpenSearchExceptionDeprecated.Returns information about the cluster-manager node.- Throws:
IOExceptionOpenSearchException
-
nodeattrs
public CompletableFuture<NodeattrsResponse> nodeattrs(NodeattrsRequest request) throws IOException, OpenSearchException Returns information about custom node attributes.- Throws:
IOExceptionOpenSearchException
-
nodeattrs
public final CompletableFuture<NodeattrsResponse> nodeattrs(Function<NodeattrsRequest.Builder, ObjectBuilder<NodeattrsRequest>> fn) throws IOException, OpenSearchExceptionReturns information about custom node attributes.- Parameters:
fn- a function that initializes a builder to create theNodeattrsRequest- Throws:
IOExceptionOpenSearchException
-
nodeattrs
public final CompletableFuture<NodeattrsResponse> nodeattrs() throws IOException, OpenSearchExceptionReturns information about custom node attributes.- Throws:
IOExceptionOpenSearchException
-
nodes
public CompletableFuture<NodesResponse> nodes(NodesRequest request) throws IOException, OpenSearchException Returns basic statistics about the performance of cluster nodes.- Throws:
IOExceptionOpenSearchException
-
nodes
public final CompletableFuture<NodesResponse> nodes(Function<NodesRequest.Builder, ObjectBuilder<NodesRequest>> fn) throws IOException, OpenSearchExceptionReturns basic statistics about the performance of cluster nodes.- Parameters:
fn- a function that initializes a builder to create theNodesRequest- Throws:
IOExceptionOpenSearchException
-
nodes
Returns basic statistics about the performance of cluster nodes.- Throws:
IOExceptionOpenSearchException
-
pendingTasks
public CompletableFuture<PendingTasksResponse> pendingTasks(PendingTasksRequest request) throws IOException, OpenSearchException Returns a concise representation of the cluster's pending tasks.- Throws:
IOExceptionOpenSearchException
-
pendingTasks
public final CompletableFuture<PendingTasksResponse> pendingTasks(Function<PendingTasksRequest.Builder, ObjectBuilder<PendingTasksRequest>> fn) throws IOException, OpenSearchExceptionReturns a concise representation of the cluster's pending tasks.- Parameters:
fn- a function that initializes a builder to create thePendingTasksRequest- Throws:
IOExceptionOpenSearchException
-
pendingTasks
public final CompletableFuture<PendingTasksResponse> pendingTasks() throws IOException, OpenSearchExceptionReturns a concise representation of the cluster's pending tasks.- Throws:
IOExceptionOpenSearchException
-
pitSegments
public CompletableFuture<PitSegmentsResponse> pitSegments(PitSegmentsRequest request) throws IOException, OpenSearchException Lists one or several CAT point-in-time segments.- Throws:
IOExceptionOpenSearchException
-
pitSegments
public final CompletableFuture<PitSegmentsResponse> pitSegments(Function<PitSegmentsRequest.Builder, ObjectBuilder<PitSegmentsRequest>> fn) throws IOException, OpenSearchExceptionLists one or several CAT point-in-time segments.- Parameters:
fn- a function that initializes a builder to create thePitSegmentsRequest- Throws:
IOExceptionOpenSearchException
-
plugins
public CompletableFuture<PluginsResponse> plugins(PluginsRequest request) throws IOException, OpenSearchException Returns information about the names, components, and versions of the installed plugins.- Throws:
IOExceptionOpenSearchException
-
plugins
public final CompletableFuture<PluginsResponse> plugins(Function<PluginsRequest.Builder, ObjectBuilder<PluginsRequest>> fn) throws IOException, OpenSearchExceptionReturns information about the names, components, and versions of the installed plugins.- Parameters:
fn- a function that initializes a builder to create thePluginsRequest- Throws:
IOExceptionOpenSearchException
-
plugins
Returns information about the names, components, and versions of the installed plugins.- Throws:
IOExceptionOpenSearchException
-
recovery
public CompletableFuture<RecoveryResponse> recovery(RecoveryRequest request) throws IOException, OpenSearchException Returns all completed and ongoing index and shard recoveries.- Throws:
IOExceptionOpenSearchException
-
recovery
public final CompletableFuture<RecoveryResponse> recovery(Function<RecoveryRequest.Builder, ObjectBuilder<RecoveryRequest>> fn) throws IOException, OpenSearchExceptionReturns all completed and ongoing index and shard recoveries.- Parameters:
fn- a function that initializes a builder to create theRecoveryRequest- Throws:
IOExceptionOpenSearchException
-
recovery
Returns all completed and ongoing index and shard recoveries.- Throws:
IOExceptionOpenSearchException
-
repositories
public CompletableFuture<RepositoriesResponse> repositories(RepositoriesRequest request) throws IOException, OpenSearchException Returns information about all snapshot repositories for a cluster.- Throws:
IOExceptionOpenSearchException
-
repositories
public final CompletableFuture<RepositoriesResponse> repositories(Function<RepositoriesRequest.Builder, ObjectBuilder<RepositoriesRequest>> fn) throws IOException, OpenSearchExceptionReturns information about all snapshot repositories for a cluster.- Parameters:
fn- a function that initializes a builder to create theRepositoriesRequest- Throws:
IOExceptionOpenSearchException
-
repositories
public final CompletableFuture<RepositoriesResponse> repositories() throws IOException, OpenSearchExceptionReturns information about all snapshot repositories for a cluster.- Throws:
IOExceptionOpenSearchException
-
segmentReplication
public CompletableFuture<SegmentReplicationResponse> segmentReplication(SegmentReplicationRequest request) throws IOException, OpenSearchException Returns information about active and last-completed segment replication events on each replica shard, including related shard-level metrics. These metrics provide information about how far behind the primary shard the replicas are lagging.- Throws:
IOExceptionOpenSearchException
-
segmentReplication
public final CompletableFuture<SegmentReplicationResponse> segmentReplication(Function<SegmentReplicationRequest.Builder, ObjectBuilder<SegmentReplicationRequest>> fn) throws IOException, OpenSearchExceptionReturns information about active and last-completed segment replication events on each replica shard, including related shard-level metrics. These metrics provide information about how far behind the primary shard the replicas are lagging.- Parameters:
fn- a function that initializes a builder to create theSegmentReplicationRequest- Throws:
IOExceptionOpenSearchException
-
segmentReplication
public final CompletableFuture<SegmentReplicationResponse> segmentReplication() throws IOException, OpenSearchExceptionReturns information about active and last-completed segment replication events on each replica shard, including related shard-level metrics. These metrics provide information about how far behind the primary shard the replicas are lagging.- Throws:
IOExceptionOpenSearchException
-
segments
public CompletableFuture<SegmentsResponse> segments(SegmentsRequest request) throws IOException, OpenSearchException Provides low-level information about the segments in the shards of an index.- Throws:
IOExceptionOpenSearchException
-
segments
public final CompletableFuture<SegmentsResponse> segments(Function<SegmentsRequest.Builder, ObjectBuilder<SegmentsRequest>> fn) throws IOException, OpenSearchExceptionProvides low-level information about the segments in the shards of an index.- Parameters:
fn- a function that initializes a builder to create theSegmentsRequest- Throws:
IOExceptionOpenSearchException
-
segments
Provides low-level information about the segments in the shards of an index.- Throws:
IOExceptionOpenSearchException
-
shards
public CompletableFuture<ShardsResponse> shards(ShardsRequest request) throws IOException, OpenSearchException Lists the states of all primary and replica shards and how they are distributed.- Throws:
IOExceptionOpenSearchException
-
shards
public final CompletableFuture<ShardsResponse> shards(Function<ShardsRequest.Builder, ObjectBuilder<ShardsRequest>> fn) throws IOException, OpenSearchExceptionLists the states of all primary and replica shards and how they are distributed.- Parameters:
fn- a function that initializes a builder to create theShardsRequest- Throws:
IOExceptionOpenSearchException
-
shards
Lists the states of all primary and replica shards and how they are distributed.- Throws:
IOExceptionOpenSearchException
-
snapshots
public CompletableFuture<SnapshotsResponse> snapshots(SnapshotsRequest request) throws IOException, OpenSearchException Lists all of the snapshots stored in a specific repository.- Throws:
IOExceptionOpenSearchException
-
snapshots
public final CompletableFuture<SnapshotsResponse> snapshots(Function<SnapshotsRequest.Builder, ObjectBuilder<SnapshotsRequest>> fn) throws IOException, OpenSearchExceptionLists all of the snapshots stored in a specific repository.- Parameters:
fn- a function that initializes a builder to create theSnapshotsRequest- Throws:
IOExceptionOpenSearchException
-
snapshots
public final CompletableFuture<SnapshotsResponse> snapshots() throws IOException, OpenSearchExceptionLists all of the snapshots stored in a specific repository.- Throws:
IOExceptionOpenSearchException
-
tasks
public CompletableFuture<TasksResponse> tasks(TasksRequest request) throws IOException, OpenSearchException Lists the progress of all tasks currently running on the cluster.- Throws:
IOExceptionOpenSearchException
-
tasks
public final CompletableFuture<TasksResponse> tasks(Function<TasksRequest.Builder, ObjectBuilder<TasksRequest>> fn) throws IOException, OpenSearchExceptionLists the progress of all tasks currently running on the cluster.- Parameters:
fn- a function that initializes a builder to create theTasksRequest- Throws:
IOExceptionOpenSearchException
-
tasks
Lists the progress of all tasks currently running on the cluster.- Throws:
IOExceptionOpenSearchException
-
templates
public CompletableFuture<TemplatesResponse> templates(TemplatesRequest request) throws IOException, OpenSearchException Lists the names, patterns, order numbers, and version numbers of index templates.- Throws:
IOExceptionOpenSearchException
-
templates
public final CompletableFuture<TemplatesResponse> templates(Function<TemplatesRequest.Builder, ObjectBuilder<TemplatesRequest>> fn) throws IOException, OpenSearchExceptionLists the names, patterns, order numbers, and version numbers of index templates.- Parameters:
fn- a function that initializes a builder to create theTemplatesRequest- Throws:
IOExceptionOpenSearchException
-
templates
public final CompletableFuture<TemplatesResponse> templates() throws IOException, OpenSearchExceptionLists the names, patterns, order numbers, and version numbers of index templates.- Throws:
IOExceptionOpenSearchException
-
threadPool
public CompletableFuture<ThreadPoolResponse> threadPool(ThreadPoolRequest request) throws IOException, OpenSearchException Returns cluster-wide thread pool statistics per node. By default the active, queued, and rejected statistics are returned for all thread pools.- Throws:
IOExceptionOpenSearchException
-
threadPool
public final CompletableFuture<ThreadPoolResponse> threadPool(Function<ThreadPoolRequest.Builder, ObjectBuilder<ThreadPoolRequest>> fn) throws IOException, OpenSearchExceptionReturns cluster-wide thread pool statistics per node. By default the active, queued, and rejected statistics are returned for all thread pools.- Parameters:
fn- a function that initializes a builder to create theThreadPoolRequest- Throws:
IOExceptionOpenSearchException
-
threadPool
public final CompletableFuture<ThreadPoolResponse> threadPool() throws IOException, OpenSearchExceptionReturns cluster-wide thread pool statistics per node. By default the active, queued, and rejected statistics are returned for all thread pools.- Throws:
IOExceptionOpenSearchException
-