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

Class DisMaxQuery.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch._types.query_dsl.DisMaxQuery.Builder

All Implemented Interfaces:

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

Enclosing class:

DisMaxQuery

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

Builder for DisMaxQuery.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DisMaxQuery	build()	Builds a DisMaxQuery.
DisMaxQuery.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final DisMaxQuery.Builder	queries(Function<Query.Builder,ObjectBuilder<Query>> fn)	Required - One or more query clauses.
final DisMaxQuery.Builder	queries(List<Query> list)	Required - One or more query clauses.
final DisMaxQuery.Builder	queries(Query value, Query... values)	Required - One or more query clauses.
protected DisMaxQuery.Builder	self()
final DisMaxQuery.Builder	tieBreaker(Float value)	Floating point number between 0 and 1.0 used to increase the relevance scores of documents matching multiple query clauses.

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

Returns:

a new builder instance.

self

@Nonnull
protected DisMaxQuery.Builder self()

Specified by:

self in class QueryBase.AbstractBuilder<DisMaxQuery.Builder>

queries

@Nonnull
public final DisMaxQuery.Builder queries(List<Query> list)

Required - One or more query clauses. Returned documents must match one or more of these queries. If a document matches multiple queries, OpenSearch uses the highest relevance score.

API name: queries

Adds all elements of list to queries.

queries

@Nonnull
public final DisMaxQuery.Builder queries(Query value,
 Query... values)

Required - One or more query clauses. Returned documents must match one or more of these queries. If a document matches multiple queries, OpenSearch uses the highest relevance score.

API name: queries

Adds one or more values to queries.

queries

@Nonnull
public final DisMaxQuery.Builder queries(Function<Query.Builder,ObjectBuilder<Query>> fn)

Required - One or more query clauses. Returned documents must match one or more of these queries. If a document matches multiple queries, OpenSearch uses the highest relevance score.

API name: queries

Adds a value to queries using a builder lambda.

tieBreaker

@Nonnull
public final DisMaxQuery.Builder tieBreaker(@Nullable
 Float value)

Floating point number between 0 and 1.0 used to increase the relevance scores of documents matching multiple query clauses.

API name: tie_breaker

build

@Nonnull
public DisMaxQuery build()

Builds a DisMaxQuery.

Specified by:

build in interface ObjectBuilder<DisMaxQuery>

Throws:

NullPointerException - if some of the required fields are null.