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

Class PhraseSuggest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.search.SuggestBase.AbstractBuilder<PhraseSuggest.Builder>

org.opensearch.client.opensearch.core.search.PhraseSuggest.Builder

All Implemented Interfaces:

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

Enclosing class:

PhraseSuggest

public static class PhraseSuggest.Builder
extends SuggestBase.AbstractBuilder<PhraseSuggest.Builder>
implements CopyableBuilder<PhraseSuggest.Builder,PhraseSuggest>

Builder for PhraseSuggest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PhraseSuggest	build()	Builds a PhraseSuggest.
PhraseSuggest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final PhraseSuggest.Builder	options(Function<PhraseSuggestOption.Builder,ObjectBuilder<PhraseSuggestOption>> fn)	Required - API name: options
final PhraseSuggest.Builder	options(List<PhraseSuggestOption> list)	Required - API name: options
final PhraseSuggest.Builder	options(PhraseSuggestOption value, PhraseSuggestOption... values)	Required - API name: options
protected PhraseSuggest.Builder	self()

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

length, offset, 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 PhraseSuggest.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<PhraseSuggest.Builder,PhraseSuggest>

Returns:

a new builder instance.

self

@Nonnull
protected PhraseSuggest.Builder self()

Specified by:

self in class SuggestBase.AbstractBuilder<PhraseSuggest.Builder>

options

@Nonnull
public final PhraseSuggest.Builder options(List<PhraseSuggestOption> list)

Required - API name: options

Adds all elements of list to options.

options

@Nonnull
public final PhraseSuggest.Builder options(PhraseSuggestOption value,
 PhraseSuggestOption... values)

Required - API name: options

Adds one or more values to options.

options

@Nonnull
public final PhraseSuggest.Builder options(Function<PhraseSuggestOption.Builder,ObjectBuilder<PhraseSuggestOption>> fn)

Required - API name: options

Adds a value to options using a builder lambda.

build

@Nonnull
public PhraseSuggest build()

Builds a PhraseSuggest.

Specified by:

build in interface ObjectBuilder<PhraseSuggest>

Throws:

NullPointerException - if some of the required fields are null.