Package co.elastic.clients.elasticsearch._types

Class PinnedRetriever.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RetrieverBase.AbstractBuilder<PinnedRetriever.Builder>

co.elastic.clients.elasticsearch._types.PinnedRetriever.Builder

All Implemented Interfaces:

WithJson<PinnedRetriever.Builder>, ObjectBuilder<PinnedRetriever>

Enclosing class:

PinnedRetriever

public static class PinnedRetriever.Builder
extends RetrieverBase.AbstractBuilder<PinnedRetriever.Builder>
implements ObjectBuilder<PinnedRetriever>

Builder for PinnedRetriever.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PinnedRetriever	build()	Builds a PinnedRetriever.
final PinnedRetriever.Builder	docs(SpecifiedDocument value, SpecifiedDocument... values)	API name: docs
final PinnedRetriever.Builder	docs(Function<SpecifiedDocument.Builder,ObjectBuilder<SpecifiedDocument>> fn)	API name: docs
final PinnedRetriever.Builder	docs(List<SpecifiedDocument> list)	API name: docs
final PinnedRetriever.Builder	ids(String value, String... values)	API name: ids
final PinnedRetriever.Builder	ids(List<String> list)	API name: ids
final PinnedRetriever.Builder	rankWindowSize(Integer value)	API name: rank_window_size
final PinnedRetriever.Builder	retriever(Retriever value)	Required - Inner retriever.
final PinnedRetriever.Builder	retriever(RetrieverVariant value)	Required - Inner retriever.
final PinnedRetriever.Builder	retriever(Function<Retriever.Builder,ObjectBuilder<Retriever>> fn)	Required - Inner retriever.
protected PinnedRetriever.Builder	self()

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

filter, filter, filter, filter, minScore, name

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

retriever

public final PinnedRetriever.Builder retriever(Retriever value)

Required - Inner retriever.

API name: retriever

retriever

public final PinnedRetriever.Builder retriever(Function<Retriever.Builder,ObjectBuilder<Retriever>> fn)

Required - Inner retriever.

API name: retriever

retriever

public final PinnedRetriever.Builder retriever(RetrieverVariant value)

Required - Inner retriever.

API name: retriever

ids

public final PinnedRetriever.Builder ids(List<String> list)

API name: ids

Adds all elements of list to ids.

ids

public final PinnedRetriever.Builder ids(String value,
 String... values)

API name: ids

Adds one or more values to ids.

docs

public final PinnedRetriever.Builder docs(List<SpecifiedDocument> list)

API name: docs

Adds all elements of list to docs.

docs

public final PinnedRetriever.Builder docs(SpecifiedDocument value,
 SpecifiedDocument... values)

API name: docs

Adds one or more values to docs.

docs

public final PinnedRetriever.Builder docs(Function<SpecifiedDocument.Builder,ObjectBuilder<SpecifiedDocument>> fn)

API name: docs

Adds a value to docs using a builder lambda.

rankWindowSize

public final PinnedRetriever.Builder rankWindowSize(@Nullable
 Integer value)

API name: rank_window_size

self

protected PinnedRetriever.Builder self()

Specified by:

self in class RetrieverBase.AbstractBuilder<PinnedRetriever.Builder>

build

public PinnedRetriever build()

Builds a PinnedRetriever.

Specified by:

build in interface ObjectBuilder<PinnedRetriever>

Throws:

NullPointerException - if some of the required fields are null.