Package org.opensearch.client.opensearch.core.mtermvectors

Class MultiTermVectorsOperation.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.mtermvectors.MultiTermVectorsOperation.Builder

All Implemented Interfaces:

CopyableBuilder<MultiTermVectorsOperation.Builder,MultiTermVectorsOperation>, MutableBuilder<MultiTermVectorsOperation.Builder,MultiTermVectorsOperation>, ObjectBuilder<MultiTermVectorsOperation>

Enclosing class:

MultiTermVectorsOperation

public static class MultiTermVectorsOperation.Builder
extends ObjectBuilderBase
implements CopyableBuilder<MultiTermVectorsOperation.Builder,MultiTermVectorsOperation>

Builder for MultiTermVectorsOperation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
MultiTermVectorsOperation	build()	Builds a MultiTermVectorsOperation.
MultiTermVectorsOperation.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final MultiTermVectorsOperation.Builder	doc(JsonData value)	An artificial document for which you want to retrieve term vectors.
final MultiTermVectorsOperation.Builder	fields(String value, String... values)	API name: fields
final MultiTermVectorsOperation.Builder	fields(List<String> list)	API name: fields
final MultiTermVectorsOperation.Builder	fieldStatistics(Boolean value)	When true, the response includes the document count, the sum of the document frequencies, and the sum of the term frequencies.
final MultiTermVectorsOperation.Builder	filter(Function<Filter.Builder,ObjectBuilder<Filter>> fn)	API name: filter
final MultiTermVectorsOperation.Builder	filter(Filter value)	API name: filter
final MultiTermVectorsOperation.Builder	id(String value)	Required - API name: _id
final MultiTermVectorsOperation.Builder	index(String value)	API name: _index
final MultiTermVectorsOperation.Builder	offsets(Boolean value)	When true, the response includes the term offsets.
final MultiTermVectorsOperation.Builder	payloads(Boolean value)	When true, the response includes the term payloads.
final MultiTermVectorsOperation.Builder	positions(Boolean value)	When true, the response includes the term positions.
final MultiTermVectorsOperation.Builder	routing(String value)	API name: routing
final MultiTermVectorsOperation.Builder	termStatistics(Boolean value)	When true, the response includes the term frequency and the document frequency.
final MultiTermVectorsOperation.Builder	version(Long value)	API name: version
final MultiTermVectorsOperation.Builder	versionType(VersionType value)	API name: 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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public MultiTermVectorsOperation.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<MultiTermVectorsOperation.Builder,MultiTermVectorsOperation>

Returns:

a new builder instance.

doc

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

An artificial document for which you want to retrieve term vectors.

API name: doc

fieldStatistics

@Nonnull
public final MultiTermVectorsOperation.Builder fieldStatistics(@Nullable
 Boolean value)

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

API name: field_statistics

fields

@Nonnull
public final MultiTermVectorsOperation.Builder fields(List<String> list)

API name: fields

Adds all elements of list to fields.

fields

@Nonnull
public final MultiTermVectorsOperation.Builder fields(String value,
 String... values)

API name: fields

Adds one or more values to fields.

filter

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

API name: filter

filter

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

API name: filter

id

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

Required - API name: _id

index

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

API name: _index

offsets

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

When true, the response includes the term offsets.

API name: offsets

payloads

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

When true, the response includes the term payloads.

API name: payloads

positions

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

When true, the response includes the term positions.

API name: positions

routing

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

API name: routing

termStatistics

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

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

API name: term_statistics

version

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

API name: version

versionType

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

API name: version_type

build

@Nonnull
public MultiTermVectorsOperation build()

Builds a MultiTermVectorsOperation.

Specified by:

build in interface ObjectBuilder<MultiTermVectorsOperation>

Throws:

NullPointerException - if some of the required fields are null.