Package org.opensearch.client.opensearch.cat

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

Constructors

Constructor	Description
OpenSearchCatAsyncClientBase(OpenSearchTransport transport, TransportOptions transportOptions)

Method Summary

Modifier and Type	Method	Description
final CompletableFuture<AliasesResponse>	aliases()	Shows information about aliases currently configured to indexes, including filter and routing information.
final CompletableFuture<AliasesResponse>	aliases(Function<AliasesRequest.Builder,ObjectBuilder<AliasesRequest>> fn)	Shows information about aliases currently configured to indexes, including filter and routing information.
CompletableFuture<AliasesResponse>	aliases(AliasesRequest request)	Shows information about aliases currently configured to indexes, including filter and routing information.
final CompletableFuture<AllocationResponse>	allocation()	Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.
final CompletableFuture<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.
CompletableFuture<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 CompletableFuture<AllPitSegmentsResponse>	allPitSegments()	Lists all active CAT point-in-time segments.
final CompletableFuture<AllPitSegmentsResponse>	allPitSegments(Function<AllPitSegmentsRequest.Builder,ObjectBuilder<AllPitSegmentsRequest>> fn)	Lists all active CAT point-in-time segments.
CompletableFuture<AllPitSegmentsResponse>	allPitSegments(AllPitSegmentsRequest request)	Lists all active CAT point-in-time segments.
final CompletableFuture<ClusterManagerResponse>	clusterManager()	Returns information about the cluster-manager node.
final CompletableFuture<ClusterManagerResponse>	clusterManager(Function<ClusterManagerRequest.Builder,ObjectBuilder<ClusterManagerRequest>> fn)	Returns information about the cluster-manager node.
CompletableFuture<ClusterManagerResponse>	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>	count(Function<CountRequest.Builder,ObjectBuilder<CountRequest>> fn)	Provides quick access to the document count of the entire cluster or of an individual index.
CompletableFuture<CountResponse>	count(CountRequest request)	Provides quick access to the document count of the entire cluster or of an individual index.
final CompletableFuture<FielddataResponse>	fielddata()	Shows how much heap memory is currently being used by field data on every data node in the cluster.
final CompletableFuture<FielddataResponse>	fielddata(Function<FielddataRequest.Builder,ObjectBuilder<FielddataRequest>> fn)	Shows how much heap memory is currently being used by field data on every data node in the cluster.
CompletableFuture<FielddataResponse>	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>	health(Function<HealthRequest.Builder,ObjectBuilder<HealthRequest>> fn)	Returns a concise representation of the cluster health.
CompletableFuture<HealthResponse>	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>	indices(Function<IndicesRequest.Builder,ObjectBuilder<IndicesRequest>> fn)	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.
CompletableFuture<IndicesResponse>	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>	master(Function<MasterRequest.Builder,ObjectBuilder<MasterRequest>> fn)	Deprecated.
CompletableFuture<MasterResponse>	master(MasterRequest request)	Deprecated.
final CompletableFuture<NodeattrsResponse>	nodeattrs()	Returns information about custom node attributes.
final CompletableFuture<NodeattrsResponse>	nodeattrs(Function<NodeattrsRequest.Builder,ObjectBuilder<NodeattrsRequest>> fn)	Returns information about custom node attributes.
CompletableFuture<NodeattrsResponse>	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>	nodes(Function<NodesRequest.Builder,ObjectBuilder<NodesRequest>> fn)	Returns basic statistics about the performance of cluster nodes.
CompletableFuture<NodesResponse>	nodes(NodesRequest request)	Returns basic statistics about the performance of cluster nodes.
final CompletableFuture<PendingTasksResponse>	pendingTasks()	Returns a concise representation of the cluster's pending tasks.
final CompletableFuture<PendingTasksResponse>	pendingTasks(Function<PendingTasksRequest.Builder,ObjectBuilder<PendingTasksRequest>> fn)	Returns a concise representation of the cluster's pending tasks.
CompletableFuture<PendingTasksResponse>	pendingTasks(PendingTasksRequest request)	Returns a concise representation of the cluster's pending tasks.
final CompletableFuture<PitSegmentsResponse>	pitSegments(Function<PitSegmentsRequest.Builder,ObjectBuilder<PitSegmentsRequest>> fn)	Lists one or several CAT point-in-time segments.
CompletableFuture<PitSegmentsResponse>	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>	plugins(Function<PluginsRequest.Builder,ObjectBuilder<PluginsRequest>> fn)	Returns information about the names, components, and versions of the installed plugins.
CompletableFuture<PluginsResponse>	plugins(PluginsRequest request)	Returns information about the names, components, and versions of the installed plugins.
final CompletableFuture<RecoveryResponse>	recovery()	Returns all completed and ongoing index and shard recoveries.
final CompletableFuture<RecoveryResponse>	recovery(Function<RecoveryRequest.Builder,ObjectBuilder<RecoveryRequest>> fn)	Returns all completed and ongoing index and shard recoveries.
CompletableFuture<RecoveryResponse>	recovery(RecoveryRequest request)	Returns all completed and ongoing index and shard recoveries.
final CompletableFuture<RepositoriesResponse>	repositories()	Returns information about all snapshot repositories for a cluster.
final CompletableFuture<RepositoriesResponse>	repositories(Function<RepositoriesRequest.Builder,ObjectBuilder<RepositoriesRequest>> fn)	Returns information about all snapshot repositories for a cluster.
CompletableFuture<RepositoriesResponse>	repositories(RepositoriesRequest request)	Returns information about all snapshot repositories for a cluster.
final CompletableFuture<SegmentReplicationResponse>	segmentReplication()	Returns information about active and last-completed segment replication events on each replica shard, including related shard-level metrics.
final CompletableFuture<SegmentReplicationResponse>	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.
CompletableFuture<SegmentReplicationResponse>	segmentReplication(SegmentReplicationRequest request)	Returns information about active and last-completed segment replication events on each replica shard, including related shard-level metrics.
final CompletableFuture<SegmentsResponse>	segments()	Provides low-level information about the segments in the shards of an index.
final CompletableFuture<SegmentsResponse>	segments(Function<SegmentsRequest.Builder,ObjectBuilder<SegmentsRequest>> fn)	Provides low-level information about the segments in the shards of an index.
CompletableFuture<SegmentsResponse>	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>	shards(Function<ShardsRequest.Builder,ObjectBuilder<ShardsRequest>> fn)	Lists the states of all primary and replica shards and how they are distributed.
CompletableFuture<ShardsResponse>	shards(ShardsRequest request)	Lists the states of all primary and replica shards and how they are distributed.
final CompletableFuture<SnapshotsResponse>	snapshots()	Lists all of the snapshots stored in a specific repository.
final CompletableFuture<SnapshotsResponse>	snapshots(Function<SnapshotsRequest.Builder,ObjectBuilder<SnapshotsRequest>> fn)	Lists all of the snapshots stored in a specific repository.
CompletableFuture<SnapshotsResponse>	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>	tasks(Function<TasksRequest.Builder,ObjectBuilder<TasksRequest>> fn)	Lists the progress of all tasks currently running on the cluster.
CompletableFuture<TasksResponse>	tasks(TasksRequest request)	Lists the progress of all tasks currently running on the cluster.
final CompletableFuture<TemplatesResponse>	templates()	Lists the names, patterns, order numbers, and version numbers of index templates.
final CompletableFuture<TemplatesResponse>	templates(Function<TemplatesRequest.Builder,ObjectBuilder<TemplatesRequest>> fn)	Lists the names, patterns, order numbers, and version numbers of index templates.
CompletableFuture<TemplatesResponse>	templates(TemplatesRequest request)	Lists the names, patterns, order numbers, and version numbers of index templates.
final CompletableFuture<ThreadPoolResponse>	threadPool()	Returns cluster-wide thread pool statistics per node.
final CompletableFuture<ThreadPoolResponse>	threadPool(Function<ThreadPoolRequest.Builder,ObjectBuilder<ThreadPoolRequest>> fn)	Returns cluster-wide thread pool statistics per node.
CompletableFuture<ThreadPoolResponse>	threadPool(ThreadPoolRequest request)	Returns cluster-wide thread pool statistics per node.

Methods inherited from class org.opensearch.client.ApiClient

_transport, _transportOptions, getDeserializer, withTransportOptions

Methods inherited from class java.lang.Object

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

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:

IOException

OpenSearchException

aliases

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

Shows information about aliases currently configured to indexes, including filter and routing information.

Parameters:

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

Throws:

IOException

OpenSearchException

aliases

public final CompletableFuture<AliasesResponse> aliases()
                                                 throws IOException,
OpenSearchException

Shows information about aliases currently configured to indexes, including filter and routing information.

Throws:

IOException

OpenSearchException

allPitSegments

public CompletableFuture<AllPitSegmentsResponse> allPitSegments(AllPitSegmentsRequest request)
                                                         throws IOException,
OpenSearchException

Lists all active CAT point-in-time segments.

Throws:

IOException

OpenSearchException

allPitSegments

public final CompletableFuture<AllPitSegmentsResponse> allPitSegments(Function<AllPitSegmentsRequest.Builder,ObjectBuilder<AllPitSegmentsRequest>> fn)
                                                               throws IOException,
OpenSearchException

Lists all active CAT point-in-time segments.

Parameters:

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

Throws:

IOException

OpenSearchException

allPitSegments

public final CompletableFuture<AllPitSegmentsResponse> allPitSegments()
                                                               throws IOException,
OpenSearchException

Lists all active CAT point-in-time segments.

Throws:

IOException

OpenSearchException

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:

IOException

OpenSearchException

allocation

public final CompletableFuture<AllocationResponse> allocation(Function<AllocationRequest.Builder,ObjectBuilder<AllocationRequest>> fn)
                                                       throws 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 the AllocationRequest

Throws:

IOException

OpenSearchException

allocation

public final CompletableFuture<AllocationResponse> allocation()
                                                       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:

IOException

OpenSearchException

clusterManager

public CompletableFuture<ClusterManagerResponse> clusterManager(ClusterManagerRequest request)
                                                         throws IOException,
OpenSearchException

Returns information about the cluster-manager node.

Throws:

IOException

OpenSearchException

clusterManager

public final CompletableFuture<ClusterManagerResponse> clusterManager(Function<ClusterManagerRequest.Builder,ObjectBuilder<ClusterManagerRequest>> fn)
                                                               throws IOException,
OpenSearchException

Returns information about the cluster-manager node.

Parameters:

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

Throws:

IOException

OpenSearchException

clusterManager

public final CompletableFuture<ClusterManagerResponse> clusterManager()
                                                               throws IOException,
OpenSearchException

Returns information about the cluster-manager node.

Throws:

IOException

OpenSearchException

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:

IOException

OpenSearchException

count

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

Provides 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 the CountRequest

Throws:

IOException

OpenSearchException

count

public final CompletableFuture<CountResponse> count()
                                             throws IOException,
OpenSearchException

Provides quick access to the document count of the entire cluster or of an individual index.

Throws:

IOException

OpenSearchException

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:

IOException

OpenSearchException

fielddata

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

Shows 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 the FielddataRequest

Throws:

IOException

OpenSearchException

fielddata

public final CompletableFuture<FielddataResponse> fielddata()
                                                     throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

health

public CompletableFuture<HealthResponse> health(HealthRequest request)
                                         throws IOException,
OpenSearchException

Returns a concise representation of the cluster health.

Throws:

IOException

OpenSearchException

health

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

Returns a concise representation of the cluster health.

Parameters:

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

Throws:

IOException

OpenSearchException

health

public final CompletableFuture<HealthResponse> health()
                                               throws IOException,
OpenSearchException

Returns a concise representation of the cluster health.

Throws:

IOException

OpenSearchException

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:

IOException

OpenSearchException

indices

public final CompletableFuture<IndicesResponse> indices(Function<IndicesRequest.Builder,ObjectBuilder<IndicesRequest>> fn)
                                                 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.

Parameters:

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

Throws:

IOException

OpenSearchException

indices

public final CompletableFuture<IndicesResponse> indices()
                                                 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:

IOException

OpenSearchException

master

@Deprecated
public CompletableFuture<MasterResponse> master(MasterRequest request)
                                         throws IOException,
OpenSearchException

Deprecated.

Returns information about the cluster-manager node.

Throws:

IOException

OpenSearchException

master

@Deprecated
public final CompletableFuture<MasterResponse> master(Function<MasterRequest.Builder,ObjectBuilder<MasterRequest>> fn)
                                               throws IOException,
OpenSearchException

Deprecated.

Returns information about the cluster-manager node.

Parameters:

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

Throws:

IOException

OpenSearchException

master

@Deprecated
public final CompletableFuture<MasterResponse> master()
                                               throws IOException,
OpenSearchException

Deprecated.

Returns information about the cluster-manager node.

Throws:

IOException

OpenSearchException

nodeattrs

public CompletableFuture<NodeattrsResponse> nodeattrs(NodeattrsRequest request)
                                               throws IOException,
OpenSearchException

Returns information about custom node attributes.

Throws:

IOException

OpenSearchException

nodeattrs

public final CompletableFuture<NodeattrsResponse> nodeattrs(Function<NodeattrsRequest.Builder,ObjectBuilder<NodeattrsRequest>> fn)
                                                     throws IOException,
OpenSearchException

Returns information about custom node attributes.

Parameters:

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

Throws:

IOException

OpenSearchException

nodeattrs

public final CompletableFuture<NodeattrsResponse> nodeattrs()
                                                     throws IOException,
OpenSearchException

Returns information about custom node attributes.

Throws:

IOException

OpenSearchException

nodes

public CompletableFuture<NodesResponse> nodes(NodesRequest request)
                                       throws IOException,
OpenSearchException

Returns basic statistics about the performance of cluster nodes.

Throws:

IOException

OpenSearchException

nodes

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

Returns basic statistics about the performance of cluster nodes.

Parameters:

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

Throws:

IOException

OpenSearchException

nodes

public final CompletableFuture<NodesResponse> nodes()
                                             throws IOException,
OpenSearchException

Returns basic statistics about the performance of cluster nodes.

Throws:

IOException

OpenSearchException

pendingTasks

public CompletableFuture<PendingTasksResponse> pendingTasks(PendingTasksRequest request)
                                                     throws IOException,
OpenSearchException

Returns a concise representation of the cluster's pending tasks.

Throws:

IOException

OpenSearchException

pendingTasks

public final CompletableFuture<PendingTasksResponse> pendingTasks(Function<PendingTasksRequest.Builder,ObjectBuilder<PendingTasksRequest>> fn)
                                                           throws IOException,
OpenSearchException

Returns a concise representation of the cluster's pending tasks.

Parameters:

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

Throws:

IOException

OpenSearchException

pendingTasks

public final CompletableFuture<PendingTasksResponse> pendingTasks()
                                                           throws IOException,
OpenSearchException

Returns a concise representation of the cluster's pending tasks.

Throws:

IOException

OpenSearchException

pitSegments

public CompletableFuture<PitSegmentsResponse> pitSegments(PitSegmentsRequest request)
                                                   throws IOException,
OpenSearchException

Lists one or several CAT point-in-time segments.

Throws:

IOException

OpenSearchException

pitSegments

public final CompletableFuture<PitSegmentsResponse> pitSegments(Function<PitSegmentsRequest.Builder,ObjectBuilder<PitSegmentsRequest>> fn)
                                                         throws IOException,
OpenSearchException

Lists one or several CAT point-in-time segments.

Parameters:

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

Throws:

IOException

OpenSearchException

plugins

public CompletableFuture<PluginsResponse> plugins(PluginsRequest request)
                                           throws IOException,
OpenSearchException

Returns information about the names, components, and versions of the installed plugins.

Throws:

IOException

OpenSearchException

plugins

public final CompletableFuture<PluginsResponse> plugins(Function<PluginsRequest.Builder,ObjectBuilder<PluginsRequest>> fn)
                                                 throws IOException,
OpenSearchException

Returns information about the names, components, and versions of the installed plugins.

Parameters:

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

Throws:

IOException

OpenSearchException

plugins

public final CompletableFuture<PluginsResponse> plugins()
                                                 throws IOException,
OpenSearchException

Returns information about the names, components, and versions of the installed plugins.

Throws:

IOException

OpenSearchException

recovery

public CompletableFuture<RecoveryResponse> recovery(RecoveryRequest request)
                                             throws IOException,
OpenSearchException

Returns all completed and ongoing index and shard recoveries.

Throws:

IOException

OpenSearchException

recovery

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

Returns all completed and ongoing index and shard recoveries.

Parameters:

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

Throws:

IOException

OpenSearchException

recovery

public final CompletableFuture<RecoveryResponse> recovery()
                                                   throws IOException,
OpenSearchException

Returns all completed and ongoing index and shard recoveries.

Throws:

IOException

OpenSearchException

repositories

public CompletableFuture<RepositoriesResponse> repositories(RepositoriesRequest request)
                                                     throws IOException,
OpenSearchException

Returns information about all snapshot repositories for a cluster.

Throws:

IOException

OpenSearchException

repositories

public final CompletableFuture<RepositoriesResponse> repositories(Function<RepositoriesRequest.Builder,ObjectBuilder<RepositoriesRequest>> fn)
                                                           throws IOException,
OpenSearchException

Returns information about all snapshot repositories for a cluster.

Parameters:

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

Throws:

IOException

OpenSearchException

repositories

public final CompletableFuture<RepositoriesResponse> repositories()
                                                           throws IOException,
OpenSearchException

Returns information about all snapshot repositories for a cluster.

Throws:

IOException

OpenSearchException

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:

IOException

OpenSearchException

segmentReplication

public final CompletableFuture<SegmentReplicationResponse> segmentReplication(Function<SegmentReplicationRequest.Builder,ObjectBuilder<SegmentReplicationRequest>> fn)
                                                                       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.

Parameters:

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

Throws:

IOException

OpenSearchException

segmentReplication

public final CompletableFuture<SegmentReplicationResponse> segmentReplication()
                                                                       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:

IOException

OpenSearchException

segments

public CompletableFuture<SegmentsResponse> segments(SegmentsRequest request)
                                             throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

segments

public final CompletableFuture<SegmentsResponse> segments(Function<SegmentsRequest.Builder,ObjectBuilder<SegmentsRequest>> fn)
                                                   throws 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 the SegmentsRequest

Throws:

IOException

OpenSearchException

segments

public final CompletableFuture<SegmentsResponse> segments()
                                                   throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

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:

IOException

OpenSearchException

shards

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

Lists the states of all primary and replica shards and how they are distributed.

Parameters:

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

Throws:

IOException

OpenSearchException

shards

public final CompletableFuture<ShardsResponse> shards()
                                               throws IOException,
OpenSearchException

Lists the states of all primary and replica shards and how they are distributed.

Throws:

IOException

OpenSearchException

snapshots

public CompletableFuture<SnapshotsResponse> snapshots(SnapshotsRequest request)
                                               throws IOException,
OpenSearchException

Lists all of the snapshots stored in a specific repository.

Throws:

IOException

OpenSearchException

snapshots

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

Lists all of the snapshots stored in a specific repository.

Parameters:

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

Throws:

IOException

OpenSearchException

snapshots

public final CompletableFuture<SnapshotsResponse> snapshots()
                                                     throws IOException,
OpenSearchException

Lists all of the snapshots stored in a specific repository.

Throws:

IOException

OpenSearchException

tasks

public CompletableFuture<TasksResponse> tasks(TasksRequest request)
                                       throws IOException,
OpenSearchException

Lists the progress of all tasks currently running on the cluster.

Throws:

IOException

OpenSearchException

tasks

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

Lists the progress of all tasks currently running on the cluster.

Parameters:

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

Throws:

IOException

OpenSearchException

tasks

public final CompletableFuture<TasksResponse> tasks()
                                             throws IOException,
OpenSearchException

Lists the progress of all tasks currently running on the cluster.

Throws:

IOException

OpenSearchException

templates

public CompletableFuture<TemplatesResponse> templates(TemplatesRequest request)
                                               throws IOException,
OpenSearchException

Lists the names, patterns, order numbers, and version numbers of index templates.

Throws:

IOException

OpenSearchException

templates

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

Lists the names, patterns, order numbers, and version numbers of index templates.

Parameters:

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

Throws:

IOException

OpenSearchException

templates

public final CompletableFuture<TemplatesResponse> templates()
                                                     throws IOException,
OpenSearchException

Lists the names, patterns, order numbers, and version numbers of index templates.

Throws:

IOException

OpenSearchException

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:

IOException

OpenSearchException

threadPool

public final CompletableFuture<ThreadPoolResponse> threadPool(Function<ThreadPoolRequest.Builder,ObjectBuilder<ThreadPoolRequest>> fn)
                                                       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.

Parameters:

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

Throws:

IOException

OpenSearchException

threadPool

public final CompletableFuture<ThreadPoolResponse> threadPool()
                                                       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:

IOException

OpenSearchException