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

Class TermSuggestOption.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.search.TermSuggestOption.Builder

All Implemented Interfaces:

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

Enclosing class:

TermSuggestOption

public static class TermSuggestOption.Builder
extends ObjectBuilderBase
implements CopyableBuilder<TermSuggestOption.Builder,TermSuggestOption>

Builder for TermSuggestOption.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TermSuggestOption	build()	Builds a TermSuggestOption.
final TermSuggestOption.Builder	collateMatch(Boolean value)	API name: collate_match
TermSuggestOption.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final TermSuggestOption.Builder	freq(Long value)	API name: freq
final TermSuggestOption.Builder	highlighted(String value)	API name: highlighted
final TermSuggestOption.Builder	score(double value)	Required - API name: score
final TermSuggestOption.Builder	text(String value)	Required - API name: text

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

Returns:

a new builder instance.

collateMatch

@Nonnull
public final TermSuggestOption.Builder collateMatch(@Nullable
 Boolean value)

API name: collate_match

freq

@Nonnull
public final TermSuggestOption.Builder freq(@Nullable
 Long value)

API name: freq

highlighted

@Nonnull
public final TermSuggestOption.Builder highlighted(@Nullable
 String value)

API name: highlighted

score

@Nonnull
public final TermSuggestOption.Builder score(double value)

Required - API name: score

text

@Nonnull
public final TermSuggestOption.Builder text(String value)

Required - API name: text

build

@Nonnull
public TermSuggestOption build()

Builds a TermSuggestOption.

Specified by:

build in interface ObjectBuilder<TermSuggestOption>

Throws:

NullPointerException - if some of the required fields are null.