Package org.opensearch.client.opensearch.core.search

Class CompletionSuggester.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.search.SuggesterBase.AbstractBuilder<CompletionSuggester.Builder>

org.opensearch.client.opensearch.core.search.CompletionSuggester.Builder

All Implemented Interfaces:

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

Enclosing class:

CompletionSuggester

public static class CompletionSuggester.Builder
extends SuggesterBase.AbstractBuilder<CompletionSuggester.Builder>
implements CopyableBuilder<CompletionSuggester.Builder,CompletionSuggester>

Builder for CompletionSuggester.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CompletionSuggester	build()	Builds a CompletionSuggester.
final CompletionSuggester.Builder	contexts(String key, List<CompletionContext> value)	API name: contexts
final CompletionSuggester.Builder	contexts(Map<String,List<CompletionContext>> map)	API name: contexts
CompletionSuggester.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final CompletionSuggester.Builder	fuzzy(Function<SuggestFuzziness.Builder,ObjectBuilder<SuggestFuzziness>> fn)	API name: fuzzy
final CompletionSuggester.Builder	fuzzy(SuggestFuzziness value)	API name: fuzzy
final CompletionSuggester.Builder	regex(String value)	API name: regex
protected CompletionSuggester.Builder	self()
final CompletionSuggester.Builder	skipDuplicates(Boolean value)	API name: skip_duplicates

Methods inherited from class org.opensearch.client.opensearch.core.search.SuggesterBase.AbstractBuilder

analyzer, field, size

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

Returns:

a new builder instance.

self

@Nonnull
protected CompletionSuggester.Builder self()

Specified by:

self in class SuggesterBase.AbstractBuilder<CompletionSuggester.Builder>

contexts

@Nonnull
public final CompletionSuggester.Builder contexts(Map<String,List<CompletionContext>> map)

API name: contexts

Adds all elements of map to contexts.

contexts

@Nonnull
public final CompletionSuggester.Builder contexts(String key,
 List<CompletionContext> value)

API name: contexts

Adds an entry to contexts.

fuzzy

@Nonnull
public final CompletionSuggester.Builder fuzzy(@Nullable
 SuggestFuzziness value)

API name: fuzzy

fuzzy

@Nonnull
public final CompletionSuggester.Builder fuzzy(Function<SuggestFuzziness.Builder,ObjectBuilder<SuggestFuzziness>> fn)

API name: fuzzy

regex

@Nonnull
public final CompletionSuggester.Builder regex(@Nullable
 String value)

API name: regex

skipDuplicates

@Nonnull
public final CompletionSuggester.Builder skipDuplicates(@Nullable
 Boolean value)

API name: skip_duplicates

build

@Nonnull
public CompletionSuggester build()

Builds a CompletionSuggester.

Specified by:

build in interface ObjectBuilder<CompletionSuggester>

Throws:

NullPointerException - if some of the required fields are null.