Package co.elastic.clients.elasticsearch.core

Class TermvectorsRequest.Builder<TDocument>

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<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 RequestBase.AbstractBuilder<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.
final TermvectorsRequest.Builder<TDocument>	doc(TDocument value)	An artificial document (a document not present in the index) for which you want to retrieve term vectors.
final TermvectorsRequest.Builder<TDocument>	fields(String value, String... values)	Comma-separated list or wildcard expressions of fields to include in the statistics.
final TermvectorsRequest.Builder<TDocument>	fields(List<String> list)	Comma-separated list or wildcard expressions of fields to include in the statistics.
final TermvectorsRequest.Builder<TDocument>	fieldStatistics(Boolean value)	If true, the response includes the document count, sum of document frequencies, and sum of total term frequencies.
final TermvectorsRequest.Builder<TDocument>	filter(Filter value)	Filter terms based on their tf-idf scores.
final TermvectorsRequest.Builder<TDocument>	filter(Function<Filter.Builder,ObjectBuilder<Filter>> fn)	Filter terms based on their tf-idf scores.
final TermvectorsRequest.Builder<TDocument>	id(String value)	Unique identifier of the document.
final TermvectorsRequest.Builder<TDocument>	index(String value)	Required - Name of the index that contains the document.
final TermvectorsRequest.Builder<TDocument>	offsets(Boolean value)	If true, the response includes term offsets.
final TermvectorsRequest.Builder<TDocument>	payloads(Boolean value)	If true, the response includes term payloads.
final TermvectorsRequest.Builder<TDocument>	perFieldAnalyzer(String key, String value)	Overrides the default per-field analyzer.
final TermvectorsRequest.Builder<TDocument>	perFieldAnalyzer(Map<String,String> map)	Overrides the default per-field analyzer.
final TermvectorsRequest.Builder<TDocument>	positions(Boolean value)	If true, the response includes term positions.
final TermvectorsRequest.Builder<TDocument>	preference(String value)	Specifies the node or shard the operation should be performed on.
final TermvectorsRequest.Builder<TDocument>	realtime(Boolean value)	If true, the request is real-time as opposed to near-real-time.
final TermvectorsRequest.Builder<TDocument>	routing(String value)	Custom value used to route operations to a specific shard.
protected TermvectorsRequest.Builder<TDocument>	self()
final TermvectorsRequest.Builder<TDocument>	tDocumentSerializer(JsonpSerializer<TDocument> value)	Serializer for TDocument.
final TermvectorsRequest.Builder<TDocument>	termStatistics(Boolean value)	If true, the response includes term frequency and document frequency.
final TermvectorsRequest.Builder<TDocument>	version(Long value)	If true, returns the document version as part of a hit.
final 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)

An artificial document (a document not present in the index) for which you want to retrieve term vectors.

API name: doc

fieldStatistics

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

If true, the response includes the document count, sum of document frequencies, and sum of total term frequencies.

API name: field_statistics

fields

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

Comma-separated list or wildcard expressions of fields to include in the statistics. Used as the default list unless a specific field list is provided in the completion_fields or fielddata_fields parameters.

API name: fields

Adds all elements of list to fields.

fields

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

Comma-separated list or wildcard expressions of fields to include in the statistics. Used as the default list unless a specific field list is provided in the completion_fields or fielddata_fields parameters.

API name: fields

Adds one or more values to fields.

filter

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

Filter terms based on their tf-idf scores.

API name: filter

filter

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

Filter terms based on their tf-idf scores.

API name: filter

id

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

Unique identifier of the document.

API name: id

index

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

Required - Name of the index that contains the document.

API name: index

offsets

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

If true, the response includes term offsets.

API name: offsets

payloads

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

If true, the response includes term payloads.

API name: payloads

perFieldAnalyzer

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

Overrides the default per-field analyzer.

API name: per_field_analyzer

Adds all entries of map to perFieldAnalyzer.

perFieldAnalyzer

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

Overrides the default per-field analyzer.

API name: per_field_analyzer

Adds an entry to perFieldAnalyzer.

positions

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

If true, the response includes term positions.

API name: positions

preference

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

Specifies the node or shard the operation should be performed on. Random by default.

API name: preference

realtime

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

If true, the request is real-time as opposed to near-real-time.

API name: realtime

routing

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

Custom value used to route operations to a specific shard.

API name: routing

termStatistics

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

If true, the response includes term frequency and document frequency.

API name: term_statistics

version

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

If true, returns the document version as part of a hit.

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 RequestBase.AbstractBuilder<TermvectorsRequest.Builder<TDocument>>

build

public TermvectorsRequest<TDocument> build()

Builds a TermvectorsRequest.

Specified by:

build in interface ObjectBuilder<TDocument>

Throws:

NullPointerException - if some of the required fields are null.