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

Class CatClient

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

  • Constructor Details

  • Method Details

    • aliases

      public 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 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 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 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 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 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 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 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 HealthResponse health​(HealthRequest request) throws java.io.IOException
      Returns a concise representation of the cluster health.
      Throws:
      java.io.IOException

    • health

      public final 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 HelpResponse help() throws java.io.IOException
      Returns help for the Cat APIs.
      Throws:
      java.io.IOException

    • indices

      public 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 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 MasterResponse master() throws java.io.IOException
      Returns information about the master node.
      Throws:
      java.io.IOException

    • nodeattrs

      public NodeAttributesResponse nodeattrs() throws java.io.IOException
      Returns information about custom node attributes.
      Throws:
      java.io.IOException

    • nodes

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

    • nodes

      public final 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 PendingTasksResponse pendingTasks() throws java.io.IOException
      Returns a concise representation of the cluster pending tasks.
      Throws:
      java.io.IOException

    • plugins

      public PluginsResponse plugins() throws java.io.IOException
      Returns information about installed plugins across nodes node.
      Throws:
      java.io.IOException

    • recovery

      public 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 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 RepositoriesResponse repositories() throws java.io.IOException
      Returns information about snapshot repositories registered in the cluster.
      Throws:
      java.io.IOException

    • segments

      public 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 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 ShardsResponse shards​(ShardsRequest request) throws java.io.IOException
      Provides a detailed view of shard allocation on nodes.
      Throws:
      java.io.IOException

    • shards

      public final 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 SnapshotsResponse snapshots​(SnapshotsRequest request) throws java.io.IOException
      Returns all snapshots in a specific repository.
      Throws:
      java.io.IOException

    • snapshots

      public final 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 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 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 TemplatesResponse templates​(TemplatesRequest request) throws java.io.IOException
      Returns information about existing templates.
      Throws:
      java.io.IOException

    • templates

      public final 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 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 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 CatClient withRequestOptions​(@Nullable org.opensearch.client.RequestOptions options)
      Creates a new CatClient(org.opensearch.client.base.Transport, org.opensearch.client.RequestOptions) with specific request options.
      Specified by:
      withRequestOptions in class ApiClient<CatClient>

    • withRequestOptions

      public CatClient withRequestOptions​(java.util.function.Function<org.opensearch.client.RequestOptions.Builder,​org.opensearch.client.RequestOptions.Builder> fn)
      Creates a new CatClient(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.