Package co.elastic.clients.elasticsearch.cat

Class HelpResponse.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<HelpResponse.Builder>

co.elastic.clients.elasticsearch.cat.HelpResponse.Builder

All Implemented Interfaces:

WithJson<HelpResponse.Builder>, ObjectBuilder<HelpResponse>

Enclosing class:

HelpResponse

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

Builder for HelpResponse.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
HelpResponse	build()	Builds a HelpResponse.
protected HelpResponse.Builder	self()
final HelpResponse.Builder	valueBody(HelpRecord value, HelpRecord... values)	Required - Response value.
final HelpResponse.Builder	valueBody(Function<HelpRecord.Builder,ObjectBuilder<HelpRecord>> fn)	Required - Response value.
final HelpResponse.Builder	valueBody(List<HelpRecord> list)	Required - Response value.
HelpResponse.Builder	withJson(jakarta.json.stream.JsonParser parser, JsonpMapper mapper)	Sets additional properties values on this object by reading from a JSON input.

Methods inherited from class co.elastic.clients.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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

valueBody

public final HelpResponse.Builder valueBody(List<HelpRecord> list)

Required - Response value.

Adds all elements of list to valueBody.

valueBody

public final HelpResponse.Builder valueBody(HelpRecord value,
 HelpRecord... values)

Required - Response value.

Adds one or more values to valueBody.

valueBody

public final HelpResponse.Builder valueBody(Function<HelpRecord.Builder,ObjectBuilder<HelpRecord>> fn)

Required - Response value.

Adds a value to valueBody using a builder lambda.

withJson

public HelpResponse.Builder withJson(jakarta.json.stream.JsonParser parser,
 JsonpMapper mapper)

Description copied from interface: WithJson

Sets additional properties values on this object by reading from a JSON input.

This is a "partial deserialization": properties that were already set keep their value if they're not present in the JSON input, and properties can also be set after having called this method, including overriding those read from the JSON input.

This low level variant of withJson gives full control on the json parser and object mapper. Most of the time using WithJson.withJson(Reader) and WithJson.withJson(InputStream) will be more convenient.

Specified by:

withJson in interface WithJson<HelpResponse.Builder>

Overrides:

withJson in class WithJsonObjectBuilderBase<HelpResponse.Builder>

Parameters:

parser - the JSONP parser

mapper - the JSONP mapper used to deserialize values and nested objects

Returns:

this object

self

protected HelpResponse.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<HelpResponse.Builder>

build

public HelpResponse build()

Builds a HelpResponse.

Specified by:

build in interface ObjectBuilder<HelpResponse>

Throws:

NullPointerException - if some of the required fields are null.