Package co.elastic.clients.elasticsearch.indices

Class SettingsSimilarity

java.lang.Object

co.elastic.clients.elasticsearch.indices.SettingsSimilarity

All Implemented Interfaces:

JsonpSerializable, OpenTaggedUnion<SettingsSimilarity.Kind,Object>, TaggedUnion<SettingsSimilarity.Kind,Object>

@JsonpDeserializable
public class SettingsSimilarity
extends Object
implements OpenTaggedUnion<SettingsSimilarity.Kind,Object>, JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
SettingsSimilarity(SettingsSimilarityVariant value)
SettingsSimilarity(String kind, JsonData value)	Build a custom plugin-defined SettingsSimilarity, given its kind and some JSON data

Method Summary

Modifier and Type	Method	Description
JsonData	_custom()	Get the custom plugin-defined variant value.
final String	_customKind()	Get the actual kind when _kind() equals SettingsSimilarity.Kind._Custom (plugin-defined variant).
final Object	_get()
boolean	_isCustom()	Is this a custom SettingsSimilarity defined by a plugin?
final SettingsSimilarity.Kind	_kind()	Get the of the kind of variant held by this object.
SettingsSimilarityBm25	bm25()	Get the BM25 variant value.
SettingsSimilarityBoolean	boolean_()	Get the boolean variant value.
SettingsSimilarityDfi	dfi()	Get the DFI variant value.
SettingsSimilarityDfr	dfr()	Get the DFR variant value.
SettingsSimilarityIb	ib()	Get the IB variant value.
boolean	isBm25()	Is this variant instance of kind BM25?
boolean	isBoolean()	Is this variant instance of kind boolean?
boolean	isDfi()	Is this variant instance of kind DFI?
boolean	isDfr()	Is this variant instance of kind DFR?
boolean	isIb()	Is this variant instance of kind IB?
boolean	isLMDirichlet()	Is this variant instance of kind LMDirichlet?
boolean	isLMJelinekMercer()	Is this variant instance of kind LMJelinekMercer?
boolean	isScripted()	Is this variant instance of kind scripted?
SettingsSimilarityLmd	lmdirichlet()	Get the LMDirichlet variant value.
SettingsSimilarityLmj	lmjelinekmercer()	Get the LMJelinekMercer variant value.
static SettingsSimilarity	of(Function<SettingsSimilarity.Builder,ObjectBuilder<SettingsSimilarity>> fn)
SettingsSimilarityScripted	scripted()	Get the scripted variant value.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupSettingsSimilarityDeserializer(ObjectDeserializer<SettingsSimilarity.Builder> op)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<SettingsSimilarity> _DESERIALIZER

Constructor Details

SettingsSimilarity

public SettingsSimilarity(SettingsSimilarityVariant value)

SettingsSimilarity

public SettingsSimilarity(String kind,
 JsonData value)

Build a custom plugin-defined SettingsSimilarity, given its kind and some JSON data

Method Details

_kind

public final SettingsSimilarity.Kind _kind()

Description copied from interface: TaggedUnion

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

Specified by:

_kind in interface TaggedUnion<SettingsSimilarity.Kind,Object>

Returns:

the variant kind

_get

public final Object _get()

Specified by:

_get in interface TaggedUnion<SettingsSimilarity.Kind,Object>

of

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

isBm25

public boolean isBm25()

Is this variant instance of kind BM25?

bm25

public SettingsSimilarityBm25 bm25()

Get the BM25 variant value.

Throws:

IllegalStateException - if the current variant is not of the BM25 kind.

isBoolean

public boolean isBoolean()

Is this variant instance of kind boolean?

boolean_

public SettingsSimilarityBoolean boolean_()

Get the boolean variant value.

Throws:

IllegalStateException - if the current variant is not of the boolean kind.

isDfi

public boolean isDfi()

Is this variant instance of kind DFI?

dfi

public SettingsSimilarityDfi dfi()

Get the DFI variant value.

Throws:

IllegalStateException - if the current variant is not of the DFI kind.

isDfr

public boolean isDfr()

Is this variant instance of kind DFR?

dfr

public SettingsSimilarityDfr dfr()

Get the DFR variant value.

Throws:

IllegalStateException - if the current variant is not of the DFR kind.

isIb

public boolean isIb()

Is this variant instance of kind IB?

ib

public SettingsSimilarityIb ib()

Get the IB variant value.

Throws:

IllegalStateException - if the current variant is not of the IB kind.

isLMDirichlet

public boolean isLMDirichlet()

Is this variant instance of kind LMDirichlet?

lmdirichlet

public SettingsSimilarityLmd lmdirichlet()

Get the LMDirichlet variant value.

Throws:

IllegalStateException - if the current variant is not of the LMDirichlet kind.

isLMJelinekMercer

public boolean isLMJelinekMercer()

Is this variant instance of kind LMJelinekMercer?

lmjelinekmercer

public SettingsSimilarityLmj lmjelinekmercer()

Get the LMJelinekMercer variant value.

Throws:

IllegalStateException - if the current variant is not of the LMJelinekMercer kind.

isScripted

public boolean isScripted()

Is this variant instance of kind scripted?

scripted

public SettingsSimilarityScripted scripted()

Get the scripted variant value.

Throws:

IllegalStateException - if the current variant is not of the scripted kind.

_isCustom

public boolean _isCustom()

Is this a custom SettingsSimilarity defined by a plugin?

_customKind

@Nullable
public final String _customKind()

Get the actual kind when _kind() equals SettingsSimilarity.Kind._Custom (plugin-defined variant).

Specified by:

_customKind in interface OpenTaggedUnion<SettingsSimilarity.Kind,Object>

_custom

public JsonData _custom()

Get the custom plugin-defined variant value.

Throws:

IllegalStateException - if the current variant is not SettingsSimilarity.Kind._Custom.

serialize

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

Specified by:

serialize in interface JsonpSerializable

toString

public String toString()

Overrides:

toString in class Object

setupSettingsSimilarityDeserializer

protected static void setupSettingsSimilarityDeserializer(ObjectDeserializer<SettingsSimilarity.Builder> op)