Package org.opensearch.client.opensearch.core

Class TermvectorsRequest.Builder<TDocument>

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.TermvectorsRequest.Builder<TDocument>

All Implemented Interfaces:

ObjectBuilder<TermvectorsRequest<TDocument>>

Enclosing class:

TermvectorsRequest<TDocument>

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

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

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

doc

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

API name: doc

fieldStatistics

public final TermvectorsRequest.Builder<TDocument> fieldStatistics(@Nullable
 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(List<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(String value,
 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(Function<Filter.Builder,ObjectBuilder<Filter>> fn)

API name: filter

id

public final TermvectorsRequest.Builder<TDocument> id(@Nullable
 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(String value)

Required - The index in which the document resides.

API name: index

offsets

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

Specifies if term offsets should be returned.

API name: offsets

payloads

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

Specifies if term payloads should be returned.

API name: payloads

perFieldAnalyzer

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

API name: per_field_analyzer

Adds all entries of map to perFieldAnalyzer.

perFieldAnalyzer

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

API name: per_field_analyzer

Adds an entry to perFieldAnalyzer.

positions

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

Specifies if term positions should be returned.

API name: positions

preference

public final TermvectorsRequest.Builder<TDocument> preference(@Nullable
 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
 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
 String value)

Specific routing value.

API name: routing

termStatistics

public final TermvectorsRequest.Builder<TDocument> termStatistics(@Nullable
 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
 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.

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.