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

Class FuzzyQuery.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch._types.query_dsl.FuzzyQuery.Builder

All Implemented Interfaces:

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

Enclosing class:

FuzzyQuery

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

Builder for FuzzyQuery.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
FuzzyQuery	build()	Builds a FuzzyQuery.
FuzzyQuery.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final FuzzyQuery.Builder	field(String value)	Required - The target field
final FuzzyQuery.Builder	fuzziness(String value)	API name: fuzziness
final FuzzyQuery.Builder	maxExpansions(Integer value)	Maximum number of variations created.
final FuzzyQuery.Builder	prefixLength(Integer value)	Number of beginning characters left unchanged when creating expansions.
final FuzzyQuery.Builder	rewrite(String value)	API name: rewrite
protected FuzzyQuery.Builder	self()
final FuzzyQuery.Builder	transpositions(Boolean value)	Indicates whether edits include transpositions of two adjacent characters (for example, ab to ba).
final FuzzyQuery.Builder	value(Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)	Required - Term you wish to find in the provided field.
final FuzzyQuery.Builder	value(FieldValue value)	Required - Term you wish to find in the provided field.

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

Returns:

a new builder instance.

self

@Nonnull
protected FuzzyQuery.Builder self()

Specified by:

self in class QueryBase.AbstractBuilder<FuzzyQuery.Builder>

field

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

Required - The target field

fuzziness

@Nonnull
public final FuzzyQuery.Builder fuzziness(@Nullable
 String value)

API name: fuzziness

maxExpansions

@Nonnull
public final FuzzyQuery.Builder maxExpansions(@Nullable
 Integer value)

Maximum number of variations created.

API name: max_expansions

prefixLength

@Nonnull
public final FuzzyQuery.Builder prefixLength(@Nullable
 Integer value)

Number of beginning characters left unchanged when creating expansions.

API name: prefix_length

rewrite

@Nonnull
public final FuzzyQuery.Builder rewrite(@Nullable
 String value)

API name: rewrite

transpositions

@Nonnull
public final FuzzyQuery.Builder transpositions(@Nullable
 Boolean value)

Indicates whether edits include transpositions of two adjacent characters (for example, ab to ba).

API name: transpositions

value

@Nonnull
public final FuzzyQuery.Builder value(FieldValue value)

Required - Term you wish to find in the provided field.

API name: value

value

@Nonnull
public final FuzzyQuery.Builder value(Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)

Required - Term you wish to find in the provided field.

API name: value

build

@Nonnull
public FuzzyQuery build()

Builds a FuzzyQuery.

Specified by:

build in interface ObjectBuilder<FuzzyQuery>

Throws:

NullPointerException - if some of the required fields are null.