Package co.elastic.clients.elasticsearch.core

Class TermvectorsRequest.Builder<TDocument>

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<TermvectorsRequest.Builder<TDocument>>

co.elastic.clients.elasticsearch.core.TermvectorsRequest.Builder<TDocument>

All Implemented Interfaces:

WithJson<TermvectorsRequest.Builder<TDocument>>, ObjectBuilder<TermvectorsRequest<TDocument>>

Enclosing class:

TermvectorsRequest<TDocument>

public static class TermvectorsRequest.Builder<TDocument>
extends WithJsonObjectBuilderBase<TermvectorsRequest.Builder<TDocument>>
implements ObjectBuilder<TermvectorsRequest<TDocument>>

Builder for TermvectorsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TermvectorsRequest<TDocument>	build()	Builds a TermvectorsRequest.
TermvectorsRequest.Builder<TDocument>	doc(TDocument value)	API name: doc
TermvectorsRequest.Builder<TDocument>	fields(java.lang.String value, java.lang.String... values)	A comma-separated list of fields to return.
TermvectorsRequest.Builder<TDocument>	fields(java.util.List<java.lang.String> list)	A comma-separated list of fields to return.
TermvectorsRequest.Builder<TDocument>	fieldStatistics(java.lang.Boolean value)	Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.
TermvectorsRequest.Builder<TDocument>	filter(Filter value)	API name: filter
TermvectorsRequest.Builder<TDocument>	filter(java.util.function.Function<Filter.Builder,ObjectBuilder<Filter>> fn)	API name: filter
TermvectorsRequest.Builder<TDocument>	id(java.lang.String value)	The id of the document, when not specified a doc param should be supplied.
TermvectorsRequest.Builder<TDocument>	index(java.lang.String value)	Required - The index in which the document resides.
TermvectorsRequest.Builder<TDocument>	offsets(java.lang.Boolean value)	Specifies if term offsets should be returned.
TermvectorsRequest.Builder<TDocument>	payloads(java.lang.Boolean value)	Specifies if term payloads should be returned.
TermvectorsRequest.Builder<TDocument>	perFieldAnalyzer(java.lang.String key, java.lang.String value)	API name: per_field_analyzer
TermvectorsRequest.Builder<TDocument>	perFieldAnalyzer(java.util.Map<java.lang.String,java.lang.String> map)	API name: per_field_analyzer
TermvectorsRequest.Builder<TDocument>	positions(java.lang.Boolean value)	Specifies if term positions should be returned.
TermvectorsRequest.Builder<TDocument>	preference(java.lang.String value)	Specify the node or shard the operation should be performed on (default: random).
TermvectorsRequest.Builder<TDocument>	realtime(java.lang.Boolean value)	Specifies if request is real-time as opposed to near-real-time (default: true).
TermvectorsRequest.Builder<TDocument>	routing(java.lang.String value)	Specific routing value.
protected TermvectorsRequest.Builder<TDocument>	self()
TermvectorsRequest.Builder<TDocument>	tDocumentSerializer(JsonpSerializer<TDocument> value)	Serializer for TDocument.
TermvectorsRequest.Builder<TDocument>	termStatistics(java.lang.Boolean value)	Specifies if total term frequency and document frequency should be returned.
TermvectorsRequest.Builder<TDocument>	version(java.lang.Long value)	Explicit version number for concurrency control
TermvectorsRequest.Builder<TDocument>	versionType(VersionType value)	Specific version type

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

doc

public final TermvectorsRequest.Builder<TDocument> doc(@Nullable
TDocument value)

API name: doc

fieldStatistics

public final TermvectorsRequest.Builder<TDocument> fieldStatistics(@Nullable
java.lang.Boolean value)

Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.

API name: field_statistics

fields

public final TermvectorsRequest.Builder<TDocument> fields(java.util.List<java.lang.String> list)

A comma-separated list of fields to return.

API name: fields

Adds all elements of list to fields.

fields

public final TermvectorsRequest.Builder<TDocument> fields(java.lang.String value,
java.lang.String... values)

A comma-separated list of fields to return.

API name: fields

Adds one or more values to fields.

filter

public final TermvectorsRequest.Builder<TDocument> filter(@Nullable
Filter value)

API name: filter

filter

public final TermvectorsRequest.Builder<TDocument> filter(java.util.function.Function<Filter.Builder,ObjectBuilder<Filter>> fn)

API name: filter

id

public final TermvectorsRequest.Builder<TDocument> id(@Nullable
java.lang.String value)

The id of the document, when not specified a doc param should be supplied.

API name: id

index

public final TermvectorsRequest.Builder<TDocument> index(java.lang.String value)

Required - The index in which the document resides.

API name: index

offsets

public final TermvectorsRequest.Builder<TDocument> offsets(@Nullable
java.lang.Boolean value)

Specifies if term offsets should be returned.

API name: offsets

payloads

public final TermvectorsRequest.Builder<TDocument> payloads(@Nullable
java.lang.Boolean value)

Specifies if term payloads should be returned.

API name: payloads

perFieldAnalyzer

public final TermvectorsRequest.Builder<TDocument> perFieldAnalyzer(java.util.Map<java.lang.String,java.lang.String> map)

API name: per_field_analyzer

Adds all entries of map to perFieldAnalyzer.

perFieldAnalyzer

public final TermvectorsRequest.Builder<TDocument> perFieldAnalyzer(java.lang.String key,
java.lang.String value)

API name: per_field_analyzer

Adds an entry to perFieldAnalyzer.

positions

public final TermvectorsRequest.Builder<TDocument> positions(@Nullable
java.lang.Boolean value)

Specifies if term positions should be returned.

API name: positions

preference

public final TermvectorsRequest.Builder<TDocument> preference(@Nullable
java.lang.String value)

Specify the node or shard the operation should be performed on (default: random).

API name: preference

realtime

public final TermvectorsRequest.Builder<TDocument> realtime(@Nullable
java.lang.Boolean value)

Specifies if request is real-time as opposed to near-real-time (default: true).

API name: realtime

routing

public final TermvectorsRequest.Builder<TDocument> routing(@Nullable
java.lang.String value)

Specific routing value.

API name: routing

termStatistics

public final TermvectorsRequest.Builder<TDocument> termStatistics(@Nullable
java.lang.Boolean value)

Specifies if total term frequency and document frequency should be returned.

API name: term_statistics

version

public final TermvectorsRequest.Builder<TDocument> version(@Nullable
java.lang.Long value)

Explicit version number for concurrency control

API name: version

versionType

public final TermvectorsRequest.Builder<TDocument> versionType(@Nullable
VersionType value)

Specific version type

API name: version_type

tDocumentSerializer

public final TermvectorsRequest.Builder<TDocument> tDocumentSerializer(@Nullable
JsonpSerializer<TDocument> value)

Serializer for TDocument. If not set, an attempt will be made to find a serializer from the JSON context.

self

protected TermvectorsRequest.Builder<TDocument> self()

Specified by:

self in class WithJsonObjectBuilderBase<TermvectorsRequest.Builder<TDocument>>

build

public TermvectorsRequest<TDocument> build()

Builds a TermvectorsRequest.

Specified by:

build in interface ObjectBuilder<TDocument>

Throws:

java.lang.NullPointerException - if some of the required fields are null.