Package org.opensearch.client.opensearch.indices

Class IndexSettingsSimilarityBm25

java.lang.Object

org.opensearch.client.opensearch.indices.IndexSettingsSimilarityBm25

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<IndexSettingsSimilarityBm25.Builder,IndexSettingsSimilarityBm25>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class IndexSettingsSimilarityBm25
extends Object
implements PlainJsonSerializable, ToCopyableBuilder<IndexSettingsSimilarityBm25.Builder,IndexSettingsSimilarityBm25>

The BM25 similarity algorithm configuration.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final float	b()	Required - The length normalization parameter.
static IndexSettingsSimilarityBm25.Builder	builder()
final boolean	discountOverlaps()	Required - Whether to discount overlapping tokens.
boolean	equals(Object o)
int	hashCode()
final float	k1()	Required - The term frequency normalization parameter.
static IndexSettingsSimilarityBm25	of(Function<IndexSettingsSimilarityBm25.Builder,ObjectBuilder<IndexSettingsSimilarityBm25>> 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	setupIndexSettingsSimilarityBm25Deserializer(ObjectDeserializer<IndexSettingsSimilarityBm25.Builder> op)
IndexSettingsSimilarityBm25.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final String	type()	Required - API name: type

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

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<IndexSettingsSimilarityBm25> _DESERIALIZER

Json deserializer for IndexSettingsSimilarityBm25

Method Details

of

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

b

public final float b()

Required - The length normalization parameter.

API name: b

discountOverlaps

public final boolean discountOverlaps()

Required - Whether to discount overlapping tokens.

API name: discount_overlaps

k1

public final float k1()

Required - The term frequency normalization parameter.

API name: k1

type

@Nonnull
public final String type()

Required - API name: type

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)

toBuilder

@Nonnull
public IndexSettingsSimilarityBm25.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<IndexSettingsSimilarityBm25.Builder,IndexSettingsSimilarityBm25>

Returns:

a new builder instance.

builder

@Nonnull
public static IndexSettingsSimilarityBm25.Builder builder()

setupIndexSettingsSimilarityBm25Deserializer

protected static void setupIndexSettingsSimilarityBm25Deserializer(ObjectDeserializer<IndexSettingsSimilarityBm25.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object