RecoveryRequest (java-client 7.17.5 API)

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

Returns information about index shard recoveries, both on-going completed.

See Also:: API specification

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class RecoveryRequest.Builder
Builder for RecoveryRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch.cat.CatRequestBase
CatRequestBase.AbstractBuilder<BuilderT extends CatRequestBase.AbstractBuilder<BuilderT>>
Field Summary

Fields

Modifier and Type Field Description

static Endpoint<RecoveryRequest,RecoveryResponse,ErrorResponse> _ENDPOINT
Endpoint "cat.recovery".

Method Summary

Modifier and Type	Method	Description
`java.lang.Boolean`	`activeOnly()`	If `true`, the response only includes ongoing shard recoveries
`Bytes`	`bytes()`	The unit in which to display byte values
`java.lang.Boolean`	`detailed()`	If `true`, the response includes detailed information about shard recoveries
`java.util.List<java.lang.String>`	`index()`	Comma-separated list or wildcard expression of index names to limit the returned information
`static RecoveryRequest`	`of(java.util.function.Function<RecoveryRequest.Builder,ObjectBuilder<RecoveryRequest>> fn)`

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

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

Field Details
- _ENDPOINT
  
  public static final Endpoint<RecoveryRequest,RecoveryResponse,ErrorResponse> _ENDPOINT
  
  Endpoint "cat.recovery".
Method Details
- of
  
  public static RecoveryRequest of(java.util.function.Function<RecoveryRequest.Builder,ObjectBuilder<RecoveryRequest>> fn)
- activeOnly
  
  @Nullable public final java.lang.Boolean activeOnly()
  
  If true, the response only includes ongoing shard recoveries
  API name: active_only
- bytes
  
  @Nullable public final Bytes bytes()
  
  The unit in which to display byte values
  API name: bytes
- detailed
  
  @Nullable public final java.lang.Boolean detailed()
  
  If true, the response includes detailed information about shard recoveries
  API name: detailed
- index
  
  public final java.util.List<java.lang.String> index()
  
  Comma-separated list or wildcard expression of index names to limit the returned information
  API name: index