Package org.opensearch.client.opensearch.api.cat

Class CatAsyncClient

java.lang.Object
org.opensearch.client.base.ApiClient<CatAsyncClient>
org.opensearch.client.opensearch.api.cat.CatAsyncClient
public class CatAsyncClient
extends ApiClient<CatAsyncClient>
Client for the cat namespace.

  • Constructor Details

  • Method Details

    • aliases

      public java.util.concurrent.CompletableFuture<AliasesResponse> aliases​(AliasesRequest request) throws java.io.IOException
      Shows information about currently configured aliases to indices including filter and routing infos.
      Throws:
      java.io.IOException

    • aliases

      public final java.util.concurrent.CompletableFuture<AliasesResponse> aliases​(java.util.function.Function<AliasesRequest.Builder,​ObjectBuilder<AliasesRequest>> fn) throws java.io.IOException
      Shows information about currently configured aliases to indices including filter and routing infos.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • allocation

      public java.util.concurrent.CompletableFuture<AllocationResponse> allocation​(AllocationRequest request) throws java.io.IOException
      Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.
      Throws:
      java.io.IOException

    • allocation

      public final java.util.concurrent.CompletableFuture<AllocationResponse> allocation​(java.util.function.Function<AllocationRequest.Builder,​ObjectBuilder<AllocationRequest>> fn) throws java.io.IOException
      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 freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • count

      public java.util.concurrent.CompletableFuture<CountResponse> count​(CountRequest request) throws java.io.IOException
      Provides quick access to the document count of the entire cluster, or individual indices.
      Throws:
      java.io.IOException

    • count

      public final java.util.concurrent.CompletableFuture<CountResponse> count​(java.util.function.Function<CountRequest.Builder,​ObjectBuilder<CountRequest>> fn) throws java.io.IOException
      Provides quick access to the document count of the entire cluster, or individual indices.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • fielddata

      public java.util.concurrent.CompletableFuture<FielddataResponse> fielddata​(FielddataRequest request) throws java.io.IOException
      Shows how much heap memory is currently being used by fielddata on every data node in the cluster.
      Throws:
      java.io.IOException

    • fielddata

      public final java.util.concurrent.CompletableFuture<FielddataResponse> fielddata​(java.util.function.Function<FielddataRequest.Builder,​ObjectBuilder<FielddataRequest>> fn) throws java.io.IOException
      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 freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • health

      public java.util.concurrent.CompletableFuture<HealthResponse> health​(HealthRequest request) throws java.io.IOException
      Returns a concise representation of the cluster health.
      Throws:
      java.io.IOException

    • health

      public final java.util.concurrent.CompletableFuture<HealthResponse> health​(java.util.function.Function<HealthRequest.Builder,​ObjectBuilder<HealthRequest>> fn) throws java.io.IOException
      Returns a concise representation of the cluster health.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • help

      public java.util.concurrent.CompletableFuture<HelpResponse> help() throws java.io.IOException
      Returns help for the Cat APIs.
      Throws:
      java.io.IOException

    • indices

      public java.util.concurrent.CompletableFuture<IndicesResponse> indices​(IndicesRequest request) throws java.io.IOException
      Returns information about indices: number of primaries and replicas, document counts, disk size, ...
      Throws:
      java.io.IOException

    • indices

      public final java.util.concurrent.CompletableFuture<IndicesResponse> indices​(java.util.function.Function<IndicesRequest.Builder,​ObjectBuilder<IndicesRequest>> fn) throws java.io.IOException
      Returns information about indices: number of primaries and replicas, document counts, disk size, ...
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • master

      public java.util.concurrent.CompletableFuture<MasterResponse> master() throws java.io.IOException
      Returns information about the master node.
      Throws:
      java.io.IOException

    • nodeattrs

      public java.util.concurrent.CompletableFuture<NodeAttributesResponse> nodeattrs() throws java.io.IOException
      Returns information about custom node attributes.
      Throws:
      java.io.IOException

    • nodes

      public java.util.concurrent.CompletableFuture<NodesResponse> nodes​(NodesRequest request) throws java.io.IOException
      Returns basic statistics about performance of cluster nodes.
      Throws:
      java.io.IOException

    • nodes

      public final java.util.concurrent.CompletableFuture<NodesResponse> nodes​(java.util.function.Function<NodesRequest.Builder,​ObjectBuilder<NodesRequest>> fn) throws java.io.IOException
      Returns basic statistics about performance of cluster nodes.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • pendingTasks

      public java.util.concurrent.CompletableFuture<PendingTasksResponse> pendingTasks() throws java.io.IOException
      Returns a concise representation of the cluster pending tasks.
      Throws:
      java.io.IOException

    • plugins

      public java.util.concurrent.CompletableFuture<PluginsResponse> plugins() throws java.io.IOException
      Returns information about installed plugins across nodes node.
      Throws:
      java.io.IOException

    • recovery

      public java.util.concurrent.CompletableFuture<RecoveryResponse> recovery​(RecoveryRequest request) throws java.io.IOException
      Returns information about index shard recoveries, both on-going completed.
      Throws:
      java.io.IOException

    • recovery

      public final java.util.concurrent.CompletableFuture<RecoveryResponse> recovery​(java.util.function.Function<RecoveryRequest.Builder,​ObjectBuilder<RecoveryRequest>> fn) throws java.io.IOException
      Returns information about index shard recoveries, both on-going completed.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • repositories

      public java.util.concurrent.CompletableFuture<RepositoriesResponse> repositories() throws java.io.IOException
      Returns information about snapshot repositories registered in the cluster.
      Throws:
      java.io.IOException

    • segments

      public java.util.concurrent.CompletableFuture<SegmentsResponse> segments​(SegmentsRequest request) throws java.io.IOException
      Provides low-level information about the segments in the shards of an index.
      Throws:
      java.io.IOException

    • segments

      public final java.util.concurrent.CompletableFuture<SegmentsResponse> segments​(java.util.function.Function<SegmentsRequest.Builder,​ObjectBuilder<SegmentsRequest>> fn) throws java.io.IOException
      Provides low-level information about the segments in the shards of an index.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • shards

      public java.util.concurrent.CompletableFuture<ShardsResponse> shards​(ShardsRequest request) throws java.io.IOException
      Provides a detailed view of shard allocation on nodes.
      Throws:
      java.io.IOException

    • shards

      public final java.util.concurrent.CompletableFuture<ShardsResponse> shards​(java.util.function.Function<ShardsRequest.Builder,​ObjectBuilder<ShardsRequest>> fn) throws java.io.IOException
      Provides a detailed view of shard allocation on nodes.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • snapshots

      public java.util.concurrent.CompletableFuture<SnapshotsResponse> snapshots​(SnapshotsRequest request) throws java.io.IOException
      Returns all snapshots in a specific repository.
      Throws:
      java.io.IOException

    • snapshots

      public final java.util.concurrent.CompletableFuture<SnapshotsResponse> snapshots​(java.util.function.Function<SnapshotsRequest.Builder,​ObjectBuilder<SnapshotsRequest>> fn) throws java.io.IOException
      Returns all snapshots in a specific repository.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • tasks

      public java.util.concurrent.CompletableFuture<TasksResponse> tasks​(TasksRequest request) throws java.io.IOException
      Returns information about the tasks currently executing on one or more nodes in the cluster.
      Throws:
      java.io.IOException

    • tasks

      public final java.util.concurrent.CompletableFuture<TasksResponse> tasks​(java.util.function.Function<TasksRequest.Builder,​ObjectBuilder<TasksRequest>> fn) throws java.io.IOException
      Returns information about the tasks currently executing on one or more nodes in the cluster.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • templates

      public java.util.concurrent.CompletableFuture<TemplatesResponse> templates​(TemplatesRequest request) throws java.io.IOException
      Returns information about existing templates.
      Throws:
      java.io.IOException

    • templates

      public final java.util.concurrent.CompletableFuture<TemplatesResponse> templates​(java.util.function.Function<TemplatesRequest.Builder,​ObjectBuilder<TemplatesRequest>> fn) throws java.io.IOException
      Returns information about existing templates.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • threadPool

      public java.util.concurrent.CompletableFuture<ThreadPoolResponse> threadPool​(ThreadPoolRequest request) throws java.io.IOException
      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.IOException

    • threadPool

      public final java.util.concurrent.CompletableFuture<ThreadPoolResponse> threadPool​(java.util.function.Function<ThreadPoolRequest.Builder,​ObjectBuilder<ThreadPoolRequest>> fn) throws java.io.IOException
      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 freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • withRequestOptions

      public CatAsyncClient withRequestOptions​(@Nullable org.opensearch.client.RequestOptions options)
      Creates a new CatAsyncClient(org.opensearch.client.base.Transport, org.opensearch.client.RequestOptions) with specific request options.
      Specified by:
      withRequestOptions in class ApiClient<CatAsyncClient>

    • withRequestOptions

      public CatAsyncClient withRequestOptions​(java.util.function.Function<org.opensearch.client.RequestOptions.Builder,​org.opensearch.client.RequestOptions.Builder> fn)
      Creates a new CatAsyncClient(org.opensearch.client.base.Transport, org.opensearch.client.RequestOptions) with specific request options, inheriting existing options.
      Parameters:
      fn - a function taking an options builder initialized with the current request options, or initialized with default values.