RecoveryRequest (java-client 2.8.0 API)

java.lang.Object
- org.opensearch.client.opensearch._types.RequestBase
- - org.opensearch.client.opensearch.cat.CatRequestBase
  - - org.opensearch.client.opensearch.cat.RecoveryRequest

```
public class RecoveryRequest
extends CatRequestBase
```
Returns information about index shard recoveries, both on-going completed.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class RecoveryRequest.Builder
Builder for RecoveryRequest.
- Nested classes/interfaces inherited from class org.opensearch.client.opensearch.cat.CatRequestBase
  CatRequestBase.CatRequestBaseBuilder<BuilderT extends CatRequestBase.CatRequestBaseBuilder>
- Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase
  RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields
Modifier and Type Field Description

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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 org.opensearch.client.opensearch.cat.CatRequestBase
headers, queryParameters, sort

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_ENDPOINT

public static final Endpoint<RecoveryRequest,RecoveryResponse,ErrorResponse> _ENDPOINT

Endpoint "cat.recovery".

Method Detail
- 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