Package co.elastic.clients.elasticsearch.core

Class TermvectorsRequest.Builder<TDocument>

java.lang.Object

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

All Implemented Interfaces:

ObjectBuilder<TermvectorsRequest<TDocument>>

Enclosing class:

TermvectorsRequest<TDocument>

public static class TermvectorsRequest.Builder<TDocument>
extends java.lang.Object
implements ObjectBuilder<TermvectorsRequest<TDocument>>

Builder for TermvectorsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TermvectorsRequest.Builder<TDocument>	addFields(java.lang.String value)	Add a value to fields(List), creating the list if needed.
TermvectorsRequest<TDocument>	build()	Builds a TermvectorsRequest.
TermvectorsRequest.Builder<TDocument>	doc(TDocument value)	API name: doc
TermvectorsRequest.Builder<TDocument>	fields(java.lang.String... value)	A comma-separated list of fields to return.
TermvectorsRequest.Builder<TDocument>	fields(java.util.List<java.lang.String> value)	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.util.Map<java.lang.String,java.lang.String> value)	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>	putPerFieldAnalyzer(java.lang.String key, java.lang.String value)	Add a key/value to perFieldAnalyzer(Map), creating the map if needed.
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.
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>	type(java.lang.String value)	The type of the document.
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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

index

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

Required - The index in which the document resides.

API name: index

id

public 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

type

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

The type of the document.

API name: type

fields

public TermvectorsRequest.Builder<TDocument> fields(@Nullable
java.util.List<java.lang.String> value)

A comma-separated list of fields to return.

API name: fields

fields

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

A comma-separated list of fields to return.

API name: fields

addFields

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

Add a value to fields(List), creating the list if needed.

fieldStatistics

public 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

offsets

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

Specifies if term offsets should be returned.

API name: offsets

payloads

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

Specifies if term payloads should be returned.

API name: payloads

positions

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

Specifies if term positions should be returned.

API name: positions

preference

public 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 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 TermvectorsRequest.Builder<TDocument> routing(@Nullable
java.lang.String value)

Specific routing value.

API name: routing

termStatistics

public 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 TermvectorsRequest.Builder<TDocument> version(@Nullable
java.lang.Long value)

Explicit version number for concurrency control

API name: version

versionType

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

Specific version type

API name: version_type

doc

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

API name: doc

filter

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

API name: filter

filter

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

API name: filter

perFieldAnalyzer

public TermvectorsRequest.Builder<TDocument> perFieldAnalyzer(@Nullable
java.util.Map<java.lang.String,java.lang.String> value)

API name: per_field_analyzer

putPerFieldAnalyzer

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

Add a key/value to perFieldAnalyzer(Map), creating the map if needed.

tDocumentSerializer

public 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.

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.