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

Class NeuralQuery.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch._types.query_dsl.NeuralQuery.Builder

All Implemented Interfaces:

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

Enclosing class:

NeuralQuery

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

Builder for NeuralQuery.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
NeuralQuery	build()	Builds a NeuralQuery.
NeuralQuery.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final NeuralQuery.Builder	field(String value)	Required - The target field
final NeuralQuery.Builder	filter(Function<Query.Builder,ObjectBuilder<Query>> fn)	API name: filter
final NeuralQuery.Builder	filter(Query value)	API name: filter
final NeuralQuery.Builder	k(Integer value)	API name: k
final NeuralQuery.Builder	maxDistance(Float value)	API name: max_distance
final NeuralQuery.Builder	minScore(Float value)	API name: min_score
final NeuralQuery.Builder	modelId(String value)	API name: model_id
final NeuralQuery.Builder	queryImage(String value)	API name: query_image
final NeuralQuery.Builder	queryText(String value)	API name: query_text
protected NeuralQuery.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 NeuralQuery.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<NeuralQuery.Builder,NeuralQuery>

Returns:

a new builder instance.

self

@Nonnull
protected NeuralQuery.Builder self()

Specified by:

self in class QueryBase.AbstractBuilder<NeuralQuery.Builder>

field

@Nonnull
public final NeuralQuery.Builder field(String value)

Required - The target field

filter

@Nonnull
public final NeuralQuery.Builder filter(@Nullable
 Query value)

API name: filter

filter

@Nonnull
public final NeuralQuery.Builder filter(Function<Query.Builder,ObjectBuilder<Query>> fn)

API name: filter

k

@Nonnull
public final NeuralQuery.Builder k(@Nullable
 Integer value)

API name: k

maxDistance

@Nonnull
public final NeuralQuery.Builder maxDistance(@Nullable
 Float value)

API name: max_distance

minScore

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

API name: min_score

modelId

@Nonnull
public final NeuralQuery.Builder modelId(@Nullable
 String value)

API name: model_id

queryImage

@Nonnull
public final NeuralQuery.Builder queryImage(@Nullable
 String value)

API name: query_image

queryText

@Nonnull
public final NeuralQuery.Builder queryText(@Nullable
 String value)

API name: query_text

build

@Nonnull
public NeuralQuery build()

Builds a NeuralQuery.

Specified by:

build in interface ObjectBuilder<NeuralQuery>

Throws:

NullPointerException - if some of the required fields are null.