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

Class PhraseSuggestCollate.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

All Implemented Interfaces:

WithJson<PhraseSuggestCollate.Builder>, ObjectBuilder<PhraseSuggestCollate>

Enclosing class:

PhraseSuggestCollate

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

Builder for PhraseSuggestCollate.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PhraseSuggestCollate	build()	Builds a PhraseSuggestCollate.
final PhraseSuggestCollate.Builder	params(String key, JsonData value)	Parameters to use if the query is templated.
final PhraseSuggestCollate.Builder	params(Map<String,JsonData> map)	Parameters to use if the query is templated.
final PhraseSuggestCollate.Builder	prune(Boolean value)	Returns all suggestions with an extra collate_match option indicating whether the generated phrase matched any document.
final PhraseSuggestCollate.Builder	query(PhraseSuggestCollateQuery value)	Required - A collate query that is run once for every suggestion.
final PhraseSuggestCollate.Builder	query(Function<PhraseSuggestCollateQuery.Builder,ObjectBuilder<PhraseSuggestCollateQuery>> fn)	Required - A collate query that is run once for every suggestion.
protected PhraseSuggestCollate.Builder	self()

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

params

public final PhraseSuggestCollate.Builder params(Map<String,JsonData> map)

Parameters to use if the query is templated.

API name: params

Adds all entries of map to params.

params

public final PhraseSuggestCollate.Builder params(String key,
 JsonData value)

Parameters to use if the query is templated.

API name: params

Adds an entry to params.

prune

public final PhraseSuggestCollate.Builder prune(@Nullable
 Boolean value)

Returns all suggestions with an extra collate_match option indicating whether the generated phrase matched any document.

API name: prune

query

public final PhraseSuggestCollate.Builder query(PhraseSuggestCollateQuery value)

Required - A collate query that is run once for every suggestion.

API name: query

query

public final PhraseSuggestCollate.Builder query(Function<PhraseSuggestCollateQuery.Builder,ObjectBuilder<PhraseSuggestCollateQuery>> fn)

Required - A collate query that is run once for every suggestion.

API name: query

self

protected PhraseSuggestCollate.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<PhraseSuggestCollate.Builder>

build

public PhraseSuggestCollate build()

Builds a PhraseSuggestCollate.

Specified by:

build in interface ObjectBuilder<PhraseSuggestCollate>

Throws:

NullPointerException - if some of the required fields are null.