Package co.elastic.clients.elasticsearch._types

Class Retriever

java.lang.Object

co.elastic.clients.elasticsearch._types.Retriever

All Implemented Interfaces:

JsonpSerializable, TaggedUnion<Retriever.Kind,Object>

@JsonpDeserializable
public class Retriever
extends Object
implements TaggedUnion<Retriever.Kind,Object>, JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Retriever.Builder
static enum	Retriever.Kind	Retriever variant kinds.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<Retriever>	_DESERIALIZER

Constructor Summary

Constructors

Constructor	Description
Retriever(RetrieverVariant value)

Method Summary

Modifier and Type	Method	Description
final Object	_get()
final Retriever.Kind	_kind()	Get the of the kind of variant held by this object.
DiversifyRetriever	diversify()	Get the diversify variant value.
boolean	isDiversify()	Is this variant instance of kind diversify?
boolean	isKnn()	Is this variant instance of kind knn?
boolean	isLinear()	Is this variant instance of kind linear?
boolean	isPinned()	Is this variant instance of kind pinned?
boolean	isRescorer()	Is this variant instance of kind rescorer?
boolean	isRrf()	Is this variant instance of kind rrf?
boolean	isRule()	Is this variant instance of kind rule?
boolean	isStandard()	Is this variant instance of kind standard?
boolean	isTextSimilarityReranker()	Is this variant instance of kind text_similarity_reranker?
KnnRetriever	knn()	Get the knn variant value.
LinearRetriever	linear()	Get the linear variant value.
static Retriever	of(Function<Retriever.Builder,ObjectBuilder<Retriever>> fn)
PinnedRetriever	pinned()	Get the pinned variant value.
RescorerRetriever	rescorer()	Get the rescorer variant value.
RRFRetriever	rrf()	Get the rrf variant value.
RuleRetriever	rule()	Get the rule variant value.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupRetrieverDeserializer(ObjectDeserializer<Retriever.Builder> op)
StandardRetriever	standard()	Get the standard variant value.
TextSimilarityReranker	textSimilarityReranker()	Get the text_similarity_reranker variant value.
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<Retriever> _DESERIALIZER

Constructor Details

Retriever

public Retriever(RetrieverVariant value)

Method Details

_kind

public final Retriever.Kind _kind()

Description copied from interface: TaggedUnion

Get the of the kind of variant held by this object.

Specified by:

_kind in interface TaggedUnion<Retriever.Kind,Object>

Returns:

the variant kind

_get

public final Object _get()

Specified by:

_get in interface TaggedUnion<Retriever.Kind,Object>

of

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

isStandard

public boolean isStandard()

Is this variant instance of kind standard?

standard

public StandardRetriever standard()

Get the standard variant value.

Throws:

IllegalStateException - if the current variant is not of the standard kind.

isKnn

public boolean isKnn()

Is this variant instance of kind knn?

knn

public KnnRetriever knn()

Get the knn variant value.

Throws:

IllegalStateException - if the current variant is not of the knn kind.

isRrf

public boolean isRrf()

Is this variant instance of kind rrf?

rrf

public RRFRetriever rrf()

Get the rrf variant value.

Throws:

IllegalStateException - if the current variant is not of the rrf kind.

isTextSimilarityReranker

public boolean isTextSimilarityReranker()

Is this variant instance of kind text_similarity_reranker?

textSimilarityReranker

public TextSimilarityReranker textSimilarityReranker()

Get the text_similarity_reranker variant value.

Throws:

IllegalStateException - if the current variant is not of the text_similarity_reranker kind.

isRule

public boolean isRule()

Is this variant instance of kind rule?

rule

public RuleRetriever rule()

Get the rule variant value.

Throws:

IllegalStateException - if the current variant is not of the rule kind.

isRescorer

public boolean isRescorer()

Is this variant instance of kind rescorer?

rescorer

public RescorerRetriever rescorer()

Get the rescorer variant value.

Throws:

IllegalStateException - if the current variant is not of the rescorer kind.

isLinear

public boolean isLinear()

Is this variant instance of kind linear?

linear

public LinearRetriever linear()

Get the linear variant value.

Throws:

IllegalStateException - if the current variant is not of the linear kind.

isPinned

public boolean isPinned()

Is this variant instance of kind pinned?

pinned

public PinnedRetriever pinned()

Get the pinned variant value.

Throws:

IllegalStateException - if the current variant is not of the pinned kind.

isDiversify

public boolean isDiversify()

Is this variant instance of kind diversify?

diversify

public DiversifyRetriever diversify()

Get the diversify variant value.

Throws:

IllegalStateException - if the current variant is not of the diversify kind.

serialize

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

Specified by:

serialize in interface JsonpSerializable

toString

public String toString()

Overrides:

toString in class Object

setupRetrieverDeserializer

protected static void setupRetrieverDeserializer(ObjectDeserializer<Retriever.Builder> op)