Package org.opensearch.client.opensearch.cat

Class HelpResponse

java.lang.Object

org.opensearch.client.opensearch.cat.HelpResponse

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable

@JsonpDeserializable
public class HelpResponse
extends Object
implements PlainJsonSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HelpResponse.Builder	Builder for HelpResponse.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<HelpResponse>	_DESERIALIZER

Method Summary

Modifier and Type	Method	Description
protected static JsonpDeserializer<HelpResponse>	createHelpResponseDeserializer()
static HelpResponse	of(Function<HelpResponse.Builder,ObjectBuilder<HelpResponse>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this value to JSON.
final List<HelpRecord>	valueBody()	Required - Response value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Field Details

_DESERIALIZER

public static final JsonpDeserializer<HelpResponse> _DESERIALIZER

Method Details

of

public static HelpResponse of(Function<HelpResponse.Builder,ObjectBuilder<HelpResponse>> fn)

valueBody

public final List<HelpRecord> valueBody()

Required - Response value.

API name: _value_body

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this value to JSON.

Specified by:

serialize in interface JsonpSerializable

createHelpResponseDeserializer

protected static JsonpDeserializer<HelpResponse> createHelpResponseDeserializer()