Package co.elastic.clients.elasticsearch.core.mtermvectors

Class MultiTermVectorsOperation.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<MultiTermVectorsOperation.Builder>

co.elastic.clients.elasticsearch.core.mtermvectors.MultiTermVectorsOperation.Builder

All Implemented Interfaces:

WithJson<MultiTermVectorsOperation.Builder>, ObjectBuilder<MultiTermVectorsOperation>

Enclosing class:

MultiTermVectorsOperation

public static class MultiTermVectorsOperation.Builder
extends WithJsonObjectBuilderBase<MultiTermVectorsOperation.Builder>
implements ObjectBuilder<MultiTermVectorsOperation>

Builder for MultiTermVectorsOperation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
MultiTermVectorsOperation	build()	Builds a MultiTermVectorsOperation.
final MultiTermVectorsOperation.Builder	doc(JsonData value)	An artificial document (a document not present in the index) for which you want to retrieve term vectors.
final MultiTermVectorsOperation.Builder	fields(String value, String... values)	Comma-separated list or wildcard expressions of fields to include in the statistics.
final MultiTermVectorsOperation.Builder	fields(List<String> list)	Comma-separated list or wildcard expressions of fields to include in the statistics.
final MultiTermVectorsOperation.Builder	fieldStatistics(Boolean value)	If true, the response includes the document count, sum of document frequencies, and sum of total term frequencies.
final MultiTermVectorsOperation.Builder	filter(Filter value)	Filter terms based on their tf-idf scores.
final MultiTermVectorsOperation.Builder	filter(Function<Filter.Builder,ObjectBuilder<Filter>> fn)	Filter terms based on their tf-idf scores.
final MultiTermVectorsOperation.Builder	id(String value)	The ID of the document.
final MultiTermVectorsOperation.Builder	index(String value)	The index of the document.
final MultiTermVectorsOperation.Builder	offsets(Boolean value)	If true, the response includes term offsets.
final MultiTermVectorsOperation.Builder	payloads(Boolean value)	If true, the response includes term payloads.
final MultiTermVectorsOperation.Builder	positions(Boolean value)	If true, the response includes term positions.
final MultiTermVectorsOperation.Builder	routing(String value)	Custom value used to route operations to a specific shard.
protected MultiTermVectorsOperation.Builder	self()
final MultiTermVectorsOperation.Builder	termStatistics(Boolean value)	If true, the response includes term frequency and document frequency.
final MultiTermVectorsOperation.Builder	version(Long value)	If true, returns the document version as part of a hit.
final MultiTermVectorsOperation.Builder	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

id

public final MultiTermVectorsOperation.Builder id(@Nullable
 String value)

The ID of the document.

API name: _id

index

public final MultiTermVectorsOperation.Builder index(@Nullable
 String value)

The index of the document.

API name: _index

doc

public final MultiTermVectorsOperation.Builder doc(@Nullable
 JsonData value)

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

API name: doc

fields

public final MultiTermVectorsOperation.Builder 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 MultiTermVectorsOperation.Builder 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.

fieldStatistics

public final MultiTermVectorsOperation.Builder 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

filter

public final MultiTermVectorsOperation.Builder filter(@Nullable
 Filter value)

Filter terms based on their tf-idf scores.

API name: filter

filter

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

Filter terms based on their tf-idf scores.

API name: filter

offsets

public final MultiTermVectorsOperation.Builder offsets(@Nullable
 Boolean value)

If true, the response includes term offsets.

API name: offsets

payloads

public final MultiTermVectorsOperation.Builder payloads(@Nullable
 Boolean value)

If true, the response includes term payloads.

API name: payloads

positions

public final MultiTermVectorsOperation.Builder positions(@Nullable
 Boolean value)

If true, the response includes term positions.

API name: positions

routing

public final MultiTermVectorsOperation.Builder routing(@Nullable
 String value)

Custom value used to route operations to a specific shard.

API name: routing

termStatistics

public final MultiTermVectorsOperation.Builder termStatistics(@Nullable
 Boolean value)

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

API name: term_statistics

version

public final MultiTermVectorsOperation.Builder version(@Nullable
 Long value)

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

API name: version

versionType

public final MultiTermVectorsOperation.Builder versionType(@Nullable
 VersionType value)

Specific version type.

API name: version_type

self

protected MultiTermVectorsOperation.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<MultiTermVectorsOperation.Builder>

build

public MultiTermVectorsOperation build()

Builds a MultiTermVectorsOperation.

Specified by:

build in interface ObjectBuilder<MultiTermVectorsOperation>

Throws:

NullPointerException - if some of the required fields are null.