Package co.elastic.clients.elasticsearch._types

Class PinnedRetriever

java.lang.Object

co.elastic.clients.elasticsearch._types.RetrieverBase

co.elastic.clients.elasticsearch._types.PinnedRetriever

All Implemented Interfaces:

RetrieverVariant, JsonpSerializable

@JsonpDeserializable
public class PinnedRetriever
extends RetrieverBase
implements RetrieverVariant

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<PinnedRetriever>	_DESERIALIZER	Json deserializer for PinnedRetriever

Method Summary

Modifier and Type	Method	Description
Retriever.Kind	_retrieverKind()	Retriever variant kind.
final List<SpecifiedDocument>	docs()	API name: docs
final List<String>	ids()	API name: ids
static PinnedRetriever	of(Function<PinnedRetriever.Builder,ObjectBuilder<PinnedRetriever>> fn)
final Integer	rankWindowSize()	API name: rank_window_size
final Retriever	retriever()	Required - Inner retriever.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupPinnedRetrieverDeserializer(ObjectDeserializer<PinnedRetriever.Builder> op)

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

filter, minScore, name, 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<PinnedRetriever> _DESERIALIZER

Json deserializer for PinnedRetriever

Method Details

of

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

_retrieverKind

public Retriever.Kind _retrieverKind()

Retriever variant kind.

Specified by:

_retrieverKind in interface RetrieverVariant

retriever

public final Retriever retriever()

Required - Inner retriever.

API name: retriever

ids

public final List<String> ids()

API name: ids

docs

public final List<SpecifiedDocument> docs()

API name: docs

rankWindowSize

@Nullable
public final Integer rankWindowSize()

API name: rank_window_size

serializeInternal

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

Overrides:

serializeInternal in class RetrieverBase

setupPinnedRetrieverDeserializer

protected static void setupPinnedRetrieverDeserializer(ObjectDeserializer<PinnedRetriever.Builder> op)