Package org.opensearch.client.opensearch._global

Class MtermvectorsRequest.Builder

java.lang.Object

org.opensearch.client.opensearch._global.MtermvectorsRequest.Builder

All Implemented Interfaces:

ObjectBuilder<MtermvectorsRequest>

Enclosing class:

MtermvectorsRequest

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

Builder for MtermvectorsRequest.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
MtermvectorsRequest.Builder	addDocs(java.util.function.Function<Operation.Builder,ObjectBuilder<Operation>> fn)	Add a value to docs(List), creating the list if needed.
MtermvectorsRequest.Builder	addDocs(Operation value)	Add a value to docs(List), creating the list if needed.
MtermvectorsRequest.Builder	addFields(java.lang.String value)	Add a value to fields(List), creating the list if needed.
MtermvectorsRequest.Builder	addIds(java.lang.String value)	Add a value to ids(List), creating the list if needed.
MtermvectorsRequest	build()	Builds a MtermvectorsRequest.
MtermvectorsRequest.Builder	docs(java.util.function.Function<Operation.Builder,ObjectBuilder<Operation>> fn)	Set docs(List) to a singleton list.
MtermvectorsRequest.Builder	docs(java.util.List<Operation> value)	API name: docs
MtermvectorsRequest.Builder	docs(Operation... value)	API name: docs
MtermvectorsRequest.Builder	fields(java.lang.String... value)	API name: fields
MtermvectorsRequest.Builder	fields(java.util.List<java.lang.String> value)	API name: fields
MtermvectorsRequest.Builder	fieldStatistics(java.lang.Boolean value)	API name: field_statistics
MtermvectorsRequest.Builder	ids(java.lang.String... value)	API name: ids
MtermvectorsRequest.Builder	ids(java.util.List<java.lang.String> value)	API name: ids
MtermvectorsRequest.Builder	index(java.lang.String value)	API name: index
MtermvectorsRequest.Builder	offsets(java.lang.Boolean value)	API name: offsets
MtermvectorsRequest.Builder	payloads(java.lang.Boolean value)	API name: payloads
MtermvectorsRequest.Builder	positions(java.lang.Boolean value)	API name: positions
MtermvectorsRequest.Builder	preference(java.lang.String value)	API name: preference
MtermvectorsRequest.Builder	realtime(java.lang.Boolean value)	API name: realtime
MtermvectorsRequest.Builder	routing(jakarta.json.JsonValue value)	API name: routing
MtermvectorsRequest.Builder	termStatistics(java.lang.Boolean value)	API name: term_statistics
MtermvectorsRequest.Builder	type(java.lang.String value)	API name: type
MtermvectorsRequest.Builder	version(java.lang.Number value)	API name: version
MtermvectorsRequest.Builder	versionType(jakarta.json.JsonValue value)	API name: 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 MtermvectorsRequest.Builder index(@Nullable java.lang.String value)

API name: index

type

public MtermvectorsRequest.Builder type(@Nullable java.lang.String value)

API name: type

fields

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

API name: fields

fields

public MtermvectorsRequest.Builder fields(java.lang.String... value)

API name: fields

addFields

public MtermvectorsRequest.Builder addFields(java.lang.String value)

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

fieldStatistics

public MtermvectorsRequest.Builder fieldStatistics(@Nullable java.lang.Boolean value)

API name: field_statistics

offsets

public MtermvectorsRequest.Builder offsets(@Nullable java.lang.Boolean value)

API name: offsets

payloads

public MtermvectorsRequest.Builder payloads(@Nullable java.lang.Boolean value)

API name: payloads

positions

public MtermvectorsRequest.Builder positions(@Nullable java.lang.Boolean value)

API name: positions

preference

public MtermvectorsRequest.Builder preference(@Nullable java.lang.String value)

API name: preference

realtime

public MtermvectorsRequest.Builder realtime(@Nullable java.lang.Boolean value)

API name: realtime

routing

public MtermvectorsRequest.Builder routing(@Nullable jakarta.json.JsonValue value)

API name: routing

termStatistics

public MtermvectorsRequest.Builder termStatistics(@Nullable java.lang.Boolean value)

API name: term_statistics

version

public MtermvectorsRequest.Builder version(@Nullable java.lang.Number value)

API name: version

versionType

public MtermvectorsRequest.Builder versionType(@Nullable jakarta.json.JsonValue value)

API name: version_type

docs

public MtermvectorsRequest.Builder docs(@Nullable java.util.List<Operation> value)

API name: docs

docs

public MtermvectorsRequest.Builder docs(Operation... value)

API name: docs

addDocs

public MtermvectorsRequest.Builder addDocs(Operation value)

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

docs

public MtermvectorsRequest.Builder docs(java.util.function.Function<Operation.Builder,ObjectBuilder<Operation>> fn)

Set docs(List) to a singleton list.

addDocs

public MtermvectorsRequest.Builder addDocs(java.util.function.Function<Operation.Builder,ObjectBuilder<Operation>> fn)

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

ids

public MtermvectorsRequest.Builder ids(@Nullable java.util.List<java.lang.String> value)

API name: ids

ids

public MtermvectorsRequest.Builder ids(java.lang.String... value)

API name: ids

addIds

public MtermvectorsRequest.Builder addIds(java.lang.String value)

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

build

public MtermvectorsRequest build()

Builds a MtermvectorsRequest.

Specified by:

build in interface ObjectBuilder<MtermvectorsRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.