Package co.elastic.clients.elasticsearch.cat

Class RecoveryRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.cat.CatRequestBase
co.elastic.clients.elasticsearch.cat.RecoveryRequest
public class RecoveryRequest extends CatRequestBase
Get shard recovery information.

Get information about ongoing and completed shard recoveries. Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing. For data streams, the API returns information about the stream’s backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API.

See Also:

  • Field Details

  • Method Details

    • of

      public static RecoveryRequest of(Function<RecoveryRequest.Builder,ObjectBuilder<RecoveryRequest>> fn)

    • activeOnly

      @Nullable public final Boolean activeOnly()
      If true, the response only includes ongoing shard recoveries.

      API name: active_only

    • bytes

      @Nullable public final Bytes bytes()
      The unit used to display byte values.

      API name: bytes

    • detailed

      @Nullable public final Boolean detailed()
      If true, the response includes detailed information about shard recoveries.

      API name: detailed

    • h

      public final List<String> h()
      A comma-separated list of columns names to display. It supports simple wildcards.

      API name: h

    • index

      public final List<String> index()
      A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

      API name: index

    • s

      public final List<String> s()
      A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

      API name: s

    • time

      @Nullable public final TimeUnit time()
      The unit used to display time values.

      API name: time