RecoveryRequest.Builder (java-client 2.8.0 API)

java.lang.Object
- org.opensearch.client.util.ObjectBuilderBase
- - org.opensearch.client.opensearch.indices.RecoveryRequest.Builder

All Implemented Interfaces:: ObjectBuilder<RecoveryRequest>

Enclosing class:: RecoveryRequest

public static class RecoveryRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<RecoveryRequest>

Builder for RecoveryRequest.

Constructor Summary

Constructors
Constructor Description

Builder()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`RecoveryRequest.Builder`	`activeOnly(java.lang.Boolean value)`	Display only those recoveries that are currently on-going
`RecoveryRequest`	`build()`	Builds a `RecoveryRequest`.
`RecoveryRequest.Builder`	`detailed(java.lang.Boolean value)`	Whether to display detailed information about shard recovery
`RecoveryRequest.Builder`	`index(java.lang.String value, java.lang.String... values)`	A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
`RecoveryRequest.Builder`	`index(java.util.List<java.lang.String> list)`	A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

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

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - activeOnly
```
public final RecoveryRequest.Builder activeOnly(@Nullable
                                                java.lang.Boolean value)
```
    Display only those recoveries that are currently on-going
    API name: active_only
  - detailed
```
public final RecoveryRequest.Builder detailed(@Nullable
                                              java.lang.Boolean value)
```
    Whether to display detailed information about shard recovery
    API name: detailed
  - index
```
public final RecoveryRequest.Builder index(java.util.List<java.lang.String> list)
```
    A comma-separated list of index names; use _all or empty string to perform the operation on all indices
    API name: index
    Adds all elements of list to index.
  - index
```
public final RecoveryRequest.Builder index(java.lang.String value,
                                           java.lang.String... values)
```
    A comma-separated list of index names; use _all or empty string to perform the operation on all indices
    API name: index
    Adds one or more values to index.
  - build
```
public RecoveryRequest build()
```
    Builds a RecoveryRequest.
    
    Specified by:
    
    build in interface ObjectBuilder<RecoveryRequest>
    
    Throws:
    
    java.lang.NullPointerException - if some of the required fields are null.