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

Class HighlighterType

java.lang.Object

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

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, TaggedUnion<HighlighterType.Kind,Object>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class HighlighterType
extends Object
implements TaggedUnion<HighlighterType.Kind,Object>, PlainJsonSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HighlighterType.Builder
static enum	HighlighterType.Kind	HighlighterType variant kinds.

Field Summary

Fields

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

Method Summary

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

Methods inherited from class java.lang.Object

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

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

toJsonString

Field Details

_DESERIALIZER

public static final JsonpDeserializer<HighlighterType> _DESERIALIZER

Method Details

_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,Object>

Returns:

the variant kind

_get

public final Object _get()

Specified by:

_get in interface TaggedUnion<HighlighterType.Kind,Object>

of

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

_toJsonString

public String _toJsonString()

isBuiltin

public boolean isBuiltin()

Is this variant instance of kind builtin?

builtin

public BuiltinHighlighterType builtin()

Get the builtin variant value.

Throws:

IllegalStateException - if the current variant is not the builtin kind.

isCustom

public boolean isCustom()

Is this variant instance of kind custom?

custom

public String custom()

Get the custom variant value.

Throws:

IllegalStateException - if the current variant is not the custom kind.

serialize

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

Specified by:

serialize in interface JsonpSerializable

toBuilder

@Nonnull
public HighlighterType.Builder toBuilder()

builder

@Nonnull
public static HighlighterType.Builder builder()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object