Package co.elastic.clients.elasticsearch.core.search

Class FieldSuggester.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<FieldSuggester.Builder>

co.elastic.clients.elasticsearch.core.search.FieldSuggester.Builder

All Implemented Interfaces:

WithJson<FieldSuggester.Builder>, ObjectBuilder<FieldSuggester>

Enclosing class:

FieldSuggester

public static class FieldSuggester.Builder
extends WithJsonObjectBuilderBase<FieldSuggester.Builder>
implements ObjectBuilder<FieldSuggester>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	FieldSuggester.Builder.ContainerBuilder

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
FieldSuggester.Builder.ContainerBuilder	_custom(String name, Object data)	Define this FieldSuggester as a plugin-defined variant.
FieldSuggester	build()
FieldSuggester.Builder.ContainerBuilder	completion(CompletionSuggester v)
FieldSuggester.Builder.ContainerBuilder	completion(Function<CompletionSuggester.Builder,ObjectBuilder<CompletionSuggester>> fn)
FieldSuggester.Builder.ContainerBuilder	phrase(PhraseSuggester v)
FieldSuggester.Builder.ContainerBuilder	phrase(Function<PhraseSuggester.Builder,ObjectBuilder<PhraseSuggester>> fn)
final FieldSuggester.Builder	prefix(String value)	Prefix used to search for suggestions.
final FieldSuggester.Builder	regex(String value)	A prefix expressed as a regular expression.
protected FieldSuggester.Builder	self()
FieldSuggester.Builder.ContainerBuilder	term(TermSuggester v)
FieldSuggester.Builder.ContainerBuilder	term(Function<TermSuggester.Builder,ObjectBuilder<TermSuggester>> fn)
final FieldSuggester.Builder	text(String value)	The text to use as input for the suggester.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

prefix

public final FieldSuggester.Builder prefix(@Nullable
 String value)

Prefix used to search for suggestions.

API name: prefix

regex

public final FieldSuggester.Builder regex(@Nullable
 String value)

A prefix expressed as a regular expression.

API name: regex

text

public final FieldSuggester.Builder text(@Nullable
 String value)

The text to use as input for the suggester. Needs to be set globally or per suggestion.

API name: text

self

protected FieldSuggester.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<FieldSuggester.Builder>

completion

public FieldSuggester.Builder.ContainerBuilder completion(CompletionSuggester v)

completion

public FieldSuggester.Builder.ContainerBuilder completion(Function<CompletionSuggester.Builder,ObjectBuilder<CompletionSuggester>> fn)

phrase

public FieldSuggester.Builder.ContainerBuilder phrase(PhraseSuggester v)

phrase

public FieldSuggester.Builder.ContainerBuilder phrase(Function<PhraseSuggester.Builder,ObjectBuilder<PhraseSuggester>> fn)

term

public FieldSuggester.Builder.ContainerBuilder term(TermSuggester v)

term

public FieldSuggester.Builder.ContainerBuilder term(Function<TermSuggester.Builder,ObjectBuilder<TermSuggester>> fn)

_custom

public FieldSuggester.Builder.ContainerBuilder _custom(String name,
 Object data)

Define this FieldSuggester as a plugin-defined variant.

Parameters:

name - the plugin-defined identifier

data - the data for this custom FieldSuggester. It is converted internally to JsonData.

build

public FieldSuggester build()

Specified by:

build in interface ObjectBuilder<FieldSuggester>