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

Class BoostingQuery.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch._types.query_dsl.BoostingQuery.Builder

All Implemented Interfaces:

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

Enclosing class:

BoostingQuery

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

Builder for BoostingQuery.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
BoostingQuery	build()	Builds a BoostingQuery.
BoostingQuery.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final BoostingQuery.Builder	negative(Function<Query.Builder,ObjectBuilder<Query>> fn)	Required - API name: negative
final BoostingQuery.Builder	negative(Query value)	Required - API name: negative
final BoostingQuery.Builder	negativeBoost(float value)	Required - Floating point number between 0 and 1.0 used to decrease the relevance scores of documents matching the negative query.
final BoostingQuery.Builder	positive(Function<Query.Builder,ObjectBuilder<Query>> fn)	Required - API name: positive
final BoostingQuery.Builder	positive(Query value)	Required - API name: positive
protected BoostingQuery.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 BoostingQuery.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<BoostingQuery.Builder,BoostingQuery>

Returns:

a new builder instance.

self

@Nonnull
protected BoostingQuery.Builder self()

Specified by:

self in class QueryBase.AbstractBuilder<BoostingQuery.Builder>

negative

@Nonnull
public final BoostingQuery.Builder negative(Query value)

Required - API name: negative

negative

@Nonnull
public final BoostingQuery.Builder negative(Function<Query.Builder,ObjectBuilder<Query>> fn)

Required - API name: negative

negativeBoost

@Nonnull
public final BoostingQuery.Builder negativeBoost(float value)

Required - Floating point number between 0 and 1.0 used to decrease the relevance scores of documents matching the negative query.

API name: negative_boost

positive

@Nonnull
public final BoostingQuery.Builder positive(Query value)

Required - API name: positive

positive

@Nonnull
public final BoostingQuery.Builder positive(Function<Query.Builder,ObjectBuilder<Query>> fn)

Required - API name: positive

build

@Nonnull
public BoostingQuery build()

Builds a BoostingQuery.

Specified by:

build in interface ObjectBuilder<BoostingQuery>

Throws:

NullPointerException - if some of the required fields are null.