Package org.opensearch.client.opensearch.cat.help

Class HelpRecord

java.lang.Object

org.opensearch.client.opensearch.cat.help.HelpRecord

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable

@JsonpDeserializable
public class HelpRecord
extends Object
implements PlainJsonSerializable

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<HelpRecord>	_DESERIALIZER	Json deserializer for HelpRecord

Method Summary

Modifier and Type	Method	Description
final String	endpoint()	Required - API name: endpoint
static HelpRecord	of(Function<HelpRecord.Builder,ObjectBuilder<HelpRecord>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupHelpRecordDeserializer(ObjectDeserializer<HelpRecord.Builder> op)

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<HelpRecord> _DESERIALIZER

Json deserializer for HelpRecord

Method Details

of

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

endpoint

public final String endpoint()

Required - API name: endpoint

serialize

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

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

setupHelpRecordDeserializer

protected static void setupHelpRecordDeserializer(ObjectDeserializer<HelpRecord.Builder> op)