Package org.opensearch.client.opensearch.indices

Class IndexSettingsSimilarityBm25.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.IndexSettingsSimilarityBm25.Builder

All Implemented Interfaces:

CopyableBuilder<IndexSettingsSimilarityBm25.Builder,IndexSettingsSimilarityBm25>, MutableBuilder<IndexSettingsSimilarityBm25.Builder,IndexSettingsSimilarityBm25>, ObjectBuilder<IndexSettingsSimilarityBm25>

Enclosing class:

IndexSettingsSimilarityBm25

public static class IndexSettingsSimilarityBm25.Builder
extends ObjectBuilderBase
implements CopyableBuilder<IndexSettingsSimilarityBm25.Builder,IndexSettingsSimilarityBm25>

Builder for IndexSettingsSimilarityBm25.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final IndexSettingsSimilarityBm25.Builder	b(float value)	Required - The length normalization parameter.
IndexSettingsSimilarityBm25	build()	Builds a IndexSettingsSimilarityBm25.
IndexSettingsSimilarityBm25.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final IndexSettingsSimilarityBm25.Builder	discountOverlaps(boolean value)	Required - Whether to discount overlapping tokens.
final IndexSettingsSimilarityBm25.Builder	k1(float value)	Required - The term frequency normalization parameter.
final IndexSettingsSimilarityBm25.Builder	type(String value)	Required - The BM25 similarity algorithm.

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

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.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public IndexSettingsSimilarityBm25.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<IndexSettingsSimilarityBm25.Builder,IndexSettingsSimilarityBm25>

Returns:

a new builder instance.

b

@Nonnull
public final IndexSettingsSimilarityBm25.Builder b(float value)

Required - The length normalization parameter.

API name: b

discountOverlaps

@Nonnull
public final IndexSettingsSimilarityBm25.Builder discountOverlaps(boolean value)

Required - Whether to discount overlapping tokens.

API name: discount_overlaps

k1

@Nonnull
public final IndexSettingsSimilarityBm25.Builder k1(float value)

Required - The term frequency normalization parameter.

API name: k1

type

@Nonnull
public final IndexSettingsSimilarityBm25.Builder type(String value)

Required - The BM25 similarity algorithm.

API name: type

build

@Nonnull
public IndexSettingsSimilarityBm25 build()

Builds a IndexSettingsSimilarityBm25.

Specified by:

build in interface ObjectBuilder<IndexSettingsSimilarityBm25>

Throws:

NullPointerException - if some of the required fields are null.