Package co.elastic.clients.elasticsearch._types

Class StandardRetriever

java.lang.Object

co.elastic.clients.elasticsearch._types.RetrieverBase

co.elastic.clients.elasticsearch._types.StandardRetriever

All Implemented Interfaces:

RetrieverVariant, JsonpSerializable

@JsonpDeserializable
public class StandardRetriever
extends RetrieverBase
implements RetrieverVariant

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RetrieverBase

RetrieverBase.AbstractBuilder<BuilderT extends RetrieverBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
Retriever.Kind	_retrieverKind()	Retriever variant kind.
final FieldCollapse	collapse()	Collapses the top documents by a specified key into a single top document per key.
final Float	minScore()	Minimum _score for matching documents.
static StandardRetriever	of(Function<StandardRetriever.Builder,ObjectBuilder<StandardRetriever>> fn)
final Query	query()	Defines a query to retrieve a set of top documents.
final List<FieldValue>	searchAfter()	Defines a search after object parameter used for pagination.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupStandardRetrieverDeserializer(ObjectDeserializer<StandardRetriever.Builder> op)
final List<SortOptions>	sort()	A sort object that that specifies the order of matching documents.
final Integer	terminateAfter()	Maximum number of documents to collect for each shard.

Methods inherited from class co.elastic.clients.elasticsearch._types.RetrieverBase

filter, serialize, setupRetrieverBaseDeserializer, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.elasticsearch._types.RetrieverVariant

_toRetriever

Field Details

_DESERIALIZER

public static final JsonpDeserializer<StandardRetriever> _DESERIALIZER

Json deserializer for StandardRetriever

Method Details

of

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

_retrieverKind

public Retriever.Kind _retrieverKind()

Retriever variant kind.

Specified by:

_retrieverKind in interface RetrieverVariant

query

@Nullable
public final Query query()

Defines a query to retrieve a set of top documents.

API name: query

searchAfter

public final List<FieldValue> searchAfter()

Defines a search after object parameter used for pagination.

API name: search_after

terminateAfter

@Nullable
public final Integer terminateAfter()

Maximum number of documents to collect for each shard.

API name: terminate_after

sort

public final List<SortOptions> sort()

A sort object that that specifies the order of matching documents.

API name: sort

minScore

@Nullable
public final Float minScore()

Minimum _score for matching documents. Documents with a lower _score are not included in the top documents.

API name: min_score

collapse

@Nullable
public final FieldCollapse collapse()

Collapses the top documents by a specified key into a single top document per key.

API name: collapse

serializeInternal

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

Overrides:

serializeInternal in class RetrieverBase

setupStandardRetrieverDeserializer

protected static void setupStandardRetrieverDeserializer(ObjectDeserializer<StandardRetriever.Builder> op)