Package org.opensearch.client.opensearch.core.search

Class HighlighterType

java.lang.Object

org.opensearch.client.opensearch.core.search.HighlighterType

All Implemented Interfaces:

JsonpSerializable, TaggedUnion<HighlighterType.Kind,java.lang.Object>

@JsonpDeserializable
public class HighlighterType
extends java.lang.Object
implements TaggedUnion<HighlighterType.Kind,java.lang.Object>, JsonpSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HighlighterType.Builder
static class	HighlighterType.Kind

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<HighlighterType>	_DESERIALIZER

Method Summary

Modifier and Type	Method	Description
java.lang.Object	_get()
HighlighterType.Kind	_kind()	Get the of the kind of variant held by this object.
java.lang.String	_toJsonString()
BuiltinHighlighterType	builtin()	Get the builtin variant value.
java.lang.String	custom()	Get the custom variant value.
boolean	isBuiltin()	Is this variant instance of kind builtin?
boolean	isCustom()	Is this variant instance of kind custom?
static HighlighterType	of(java.util.function.Function<HighlighterType.Builder,ObjectBuilder<HighlighterType>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

Methods inherited from class java.lang.Object

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

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<HighlighterType> _DESERIALIZER

Method Detail

_kind

public final HighlighterType.Kind _kind()

Description copied from interface: TaggedUnion

Get the of the kind of variant held by this object.

Specified by:

_kind in interface TaggedUnion<HighlighterType.Kind,java.lang.Object>

Returns:

the variant kind

_get

public final java.lang.Object _get()

Specified by:

_get in interface TaggedUnion<HighlighterType.Kind,java.lang.Object>

_toJsonString

public java.lang.String _toJsonString()

of

public static HighlighterType of(java.util.function.Function<HighlighterType.Builder,ObjectBuilder<HighlighterType>> fn)

isBuiltin

public boolean isBuiltin()

Is this variant instance of kind builtin?

builtin

public BuiltinHighlighterType builtin()

Get the builtin variant value.

Throws:

java.lang.IllegalStateException - if the current variant is not of the builtin kind.

isCustom

public boolean isCustom()

Is this variant instance of kind custom?

custom

public java.lang.String custom()

Get the custom variant value.

Throws:

java.lang.IllegalStateException - if the current variant is not of the custom kind.

serialize

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

Specified by:

serialize in interface JsonpSerializable