Package org.opensearch.client.opensearch._types.query_dsl

Class FunctionScoreQuery.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.query_dsl.QueryBase.AbstractBuilder<FunctionScoreQuery.Builder>

org.opensearch.client.opensearch._types.query_dsl.FunctionScoreQuery.Builder

All Implemented Interfaces:

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

Enclosing class:

FunctionScoreQuery

public static class FunctionScoreQuery.Builder
extends QueryBase.AbstractBuilder<FunctionScoreQuery.Builder>
implements CopyableBuilder<FunctionScoreQuery.Builder,FunctionScoreQuery>

Builder for FunctionScoreQuery.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final FunctionScoreQuery.Builder	boostMode(FunctionBoostMode value)	API name: boost_mode
FunctionScoreQuery	build()	Builds a FunctionScoreQuery.
FunctionScoreQuery.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final FunctionScoreQuery.Builder	functions(Function<FunctionScore.Builder,ObjectBuilder<FunctionScore>> fn)	One or more functions that compute a new score for each document returned by the query.
final FunctionScoreQuery.Builder	functions(List<FunctionScore> list)	One or more functions that compute a new score for each document returned by the query.
final FunctionScoreQuery.Builder	functions(FunctionScore value, FunctionScore... values)	One or more functions that compute a new score for each document returned by the query.
final FunctionScoreQuery.Builder	maxBoost(Float value)	Restricts the new score to not exceed the provided limit.
final FunctionScoreQuery.Builder	minScore(Float value)	Excludes documents that do not meet the provided score threshold.
final FunctionScoreQuery.Builder	query(Function<Query.Builder,ObjectBuilder<Query>> fn)	API name: query
final FunctionScoreQuery.Builder	query(Query value)	API name: query
final FunctionScoreQuery.Builder	scoreMode(FunctionScoreMode value)	API name: score_mode
protected FunctionScoreQuery.Builder	self()

Methods inherited from class org.opensearch.client.opensearch._types.query_dsl.QueryBase.AbstractBuilder

boost, queryName

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 FunctionScoreQuery.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<FunctionScoreQuery.Builder,FunctionScoreQuery>

Returns:

a new builder instance.

self

@Nonnull
protected FunctionScoreQuery.Builder self()

Specified by:

self in class QueryBase.AbstractBuilder<FunctionScoreQuery.Builder>

boostMode

@Nonnull
public final FunctionScoreQuery.Builder boostMode(@Nullable
 FunctionBoostMode value)

API name: boost_mode

functions

@Nonnull
public final FunctionScoreQuery.Builder functions(List<FunctionScore> list)

One or more functions that compute a new score for each document returned by the query.

API name: functions

Adds all elements of list to functions.

functions

@Nonnull
public final FunctionScoreQuery.Builder functions(FunctionScore value,
 FunctionScore... values)

One or more functions that compute a new score for each document returned by the query.

API name: functions

Adds one or more values to functions.

functions

@Nonnull
public final FunctionScoreQuery.Builder functions(Function<FunctionScore.Builder,ObjectBuilder<FunctionScore>> fn)

One or more functions that compute a new score for each document returned by the query.

API name: functions

Adds a value to functions using a builder lambda.

maxBoost

@Nonnull
public final FunctionScoreQuery.Builder maxBoost(@Nullable
 Float value)

Restricts the new score to not exceed the provided limit.

API name: max_boost

minScore

@Nonnull
public final FunctionScoreQuery.Builder minScore(@Nullable
 Float value)

Excludes documents that do not meet the provided score threshold.

API name: min_score

query

@Nonnull
public final FunctionScoreQuery.Builder query(@Nullable
 Query value)

API name: query

query

@Nonnull
public final FunctionScoreQuery.Builder query(Function<Query.Builder,ObjectBuilder<Query>> fn)

API name: query

scoreMode

@Nonnull
public final FunctionScoreQuery.Builder scoreMode(@Nullable
 FunctionScoreMode value)

API name: score_mode

build

@Nonnull
public FunctionScoreQuery build()

Builds a FunctionScoreQuery.

Specified by:

build in interface ObjectBuilder<FunctionScoreQuery>

Throws:

NullPointerException - if some of the required fields are null.