HelpResponse.Builder (java-client 2.8.0 API)

java.lang.Object
- org.opensearch.client.util.ObjectBuilderBase
- - org.opensearch.client.opensearch.cat.HelpResponse.Builder

All Implemented Interfaces:: ObjectBuilder<HelpResponse>

Enclosing class:: HelpResponse

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

Builder for HelpResponse.

Constructor Summary

Constructors
Constructor Description

Builder()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`HelpResponse`	`build()`	Builds a `HelpResponse`.
`HelpResponse.Builder`	`valueBody(java.util.function.Function<HelpRecord.Builder,ObjectBuilder<HelpRecord>> fn)`	Required - Response value.
`HelpResponse.Builder`	`valueBody(java.util.List<HelpRecord> list)`	Required - Response value.
`HelpResponse.Builder`	`valueBody(HelpRecord value, HelpRecord... values)`	Required - Response value.

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
  - valueBody
```
public final HelpResponse.Builder valueBody(java.util.List<HelpRecord> list)
```
    Required - Response value.
    API name: _value_body
    Adds all elements of list to valueBody.
  - valueBody
```
public final HelpResponse.Builder valueBody(HelpRecord value,
                                            HelpRecord... values)
```
    Required - Response value.
    API name: _value_body
    Adds one or more values to valueBody.
  - valueBody
```
public final HelpResponse.Builder valueBody(java.util.function.Function<HelpRecord.Builder,ObjectBuilder<HelpRecord>> fn)
```
    Required - Response value.
    API name: _value_body
    Adds a value to valueBody using a builder lambda.
  - build
```
public HelpResponse build()
```
    Builds a HelpResponse.
    
    Specified by:
    
    build in interface ObjectBuilder<HelpResponse>
    
    Throws:
    
    java.lang.NullPointerException - if some of the required fields are null.