Package org.opensearch.client.opensearch.core

Class MtermvectorsRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.MtermvectorsRequest.Builder

All Implemented Interfaces:

ObjectBuilder<MtermvectorsRequest>

Enclosing class:

MtermvectorsRequest

public static class MtermvectorsRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<MtermvectorsRequest>

Builder for MtermvectorsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
MtermvectorsRequest	build()	Builds a MtermvectorsRequest.
MtermvectorsRequest.Builder	docs(java.util.function.Function<MultiTermVectorsOperation.Builder,ObjectBuilder<MultiTermVectorsOperation>> fn)	API name: docs
MtermvectorsRequest.Builder	docs(java.util.List<MultiTermVectorsOperation> list)	API name: docs
MtermvectorsRequest.Builder	docs(MultiTermVectorsOperation value, MultiTermVectorsOperation... values)	API name: docs
MtermvectorsRequest.Builder	fields(java.lang.String value, java.lang.String... values)	A comma-separated list of fields to return.
MtermvectorsRequest.Builder	fields(java.util.List<java.lang.String> list)	A comma-separated list of fields to return.
MtermvectorsRequest.Builder	fieldStatistics(java.lang.Boolean value)	Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.
MtermvectorsRequest.Builder	ids(java.lang.String value, java.lang.String... values)	API name: ids
MtermvectorsRequest.Builder	ids(java.util.List<java.lang.String> list)	API name: ids
MtermvectorsRequest.Builder	index(java.lang.String value)	The index in which the document resides.
MtermvectorsRequest.Builder	offsets(java.lang.Boolean value)	Specifies if term offsets should be returned.
MtermvectorsRequest.Builder	payloads(java.lang.Boolean value)	Specifies if term payloads should be returned.
MtermvectorsRequest.Builder	positions(java.lang.Boolean value)	Specifies if term positions should be returned.
MtermvectorsRequest.Builder	preference(java.lang.String value)	Specify the node or shard the operation should be performed on (default: random) .Applies to all returned documents unless otherwise specified in body "params" or "docs".
MtermvectorsRequest.Builder	realtime(java.lang.Boolean value)	Specifies if requests are real-time as opposed to near-real-time (default: true).
MtermvectorsRequest.Builder	routing(java.lang.String value)	Specific routing value.
MtermvectorsRequest.Builder	termStatistics(java.lang.Boolean value)	Specifies if total term frequency and document frequency should be returned.
MtermvectorsRequest.Builder	version(java.lang.Long value)	Explicit version number for concurrency control
MtermvectorsRequest.Builder	versionType(VersionType value)	Specific version type

Methods inherited from class org.opensearch.client.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

Constructor Detail

Builder

public Builder()

Method Detail

docs

public final MtermvectorsRequest.Builder docs(java.util.List<MultiTermVectorsOperation> list)

API name: docs

Adds all elements of list to docs.

docs

public final MtermvectorsRequest.Builder docs(MultiTermVectorsOperation value,
                                              MultiTermVectorsOperation... values)

API name: docs

Adds one or more values to docs.

docs

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

API name: docs

Adds a value to docs using a builder lambda.

fieldStatistics

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

Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".

API name: field_statistics

fields

public final MtermvectorsRequest.Builder fields(java.util.List<java.lang.String> list)

A comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body "params" or "docs".

API name: fields

Adds all elements of list to fields.

fields

public final MtermvectorsRequest.Builder fields(java.lang.String value,
                                                java.lang.String... values)

A comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body "params" or "docs".

API name: fields

Adds one or more values to fields.

ids

public final MtermvectorsRequest.Builder ids(java.util.List<java.lang.String> list)

API name: ids

Adds all elements of list to ids.

ids

public final MtermvectorsRequest.Builder ids(java.lang.String value,
                                             java.lang.String... values)

API name: ids

Adds one or more values to ids.

index

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

The index in which the document resides.

API name: index

offsets

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

Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".

API name: offsets

payloads

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

Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".

API name: payloads

positions

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

Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".

API name: positions

preference

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

Specify the node or shard the operation should be performed on (default: random) .Applies to all returned documents unless otherwise specified in body "params" or "docs".

API name: preference

realtime

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

Specifies if requests are real-time as opposed to near-real-time (default: true).

API name: realtime

routing

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

Specific routing value. Applies to all returned documents unless otherwise specified in body "params" or "docs".

API name: routing

termStatistics

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

Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".

API name: term_statistics

version

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

Explicit version number for concurrency control

API name: version

versionType

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

Specific version type

API name: version_type

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.