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

Class PhraseSuggestCollate

java.lang.Object

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

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class PhraseSuggestCollate
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PhraseSuggestCollate.Builder	Builder for PhraseSuggestCollate.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<PhraseSuggestCollate>	_DESERIALIZER	Json deserializer for PhraseSuggestCollate

Method Summary

Modifier and Type	Method	Description
static PhraseSuggestCollate	of(Function<PhraseSuggestCollate.Builder,ObjectBuilder<PhraseSuggestCollate>> fn)
final Map<String,JsonData>	params()	Parameters to use if the query is templated.
final Boolean	prune()	Returns all suggestions with an extra collate_match option indicating whether the generated phrase matched any document.
final PhraseSuggestCollateQuery	query()	Required - A collate query that is run once for every suggestion.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupPhraseSuggestCollateDeserializer(ObjectDeserializer<PhraseSuggestCollate.Builder> op)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<PhraseSuggestCollate> _DESERIALIZER

Json deserializer for PhraseSuggestCollate

Method Details

of

public static PhraseSuggestCollate of(Function<PhraseSuggestCollate.Builder,ObjectBuilder<PhraseSuggestCollate>> fn)

params

public final Map<String,JsonData> params()

Parameters to use if the query is templated.

API name: params

prune

@Nullable
public final Boolean prune()

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

API name: prune

query

public final PhraseSuggestCollateQuery query()

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

API name: query

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

toString

public String toString()

Overrides:

toString in class Object

setupPhraseSuggestCollateDeserializer

protected static void setupPhraseSuggestCollateDeserializer(ObjectDeserializer<PhraseSuggestCollate.Builder> op)