ClearScrollResponse.Builder (java-client 2.8.0 API)

java.lang.Object
- org.opensearch.client.util.ObjectBuilderBase
- - org.opensearch.client.opensearch.core.ClearScrollResponse.Builder

All Implemented Interfaces:

ObjectBuilder<ClearScrollResponse>

Enclosing class:

ClearScrollResponse
```
public static class ClearScrollResponse.Builder
extends ObjectBuilderBase
implements ObjectBuilder<ClearScrollResponse>
```
Builder for ClearScrollResponse.

Constructor Summary

Constructors
Constructor Description

Builder()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ClearScrollResponse`	`build()`	Builds a `ClearScrollResponse`.
`ClearScrollResponse.Builder`	`numFreed(int value)`	Required - API name: `num_freed`
`ClearScrollResponse.Builder`	`succeeded(boolean value)`	Required - API name: `succeeded`

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
  - succeeded
```
public final ClearScrollResponse.Builder succeeded(boolean value)
```
    Required - API name: succeeded
  - numFreed
```
public final ClearScrollResponse.Builder numFreed(int value)
```
    Required - API name: num_freed
  - build
```
public ClearScrollResponse build()
```
    Builds a ClearScrollResponse.
    
    Specified by:
    
    build in interface ObjectBuilder<ClearScrollResponse>
    
    Throws:
    
    java.lang.NullPointerException - if some of the required fields are null.