Package org.opensearch.client.opensearch.core

Class MtermvectorsRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<MtermvectorsRequest.Builder>

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

All Implemented Interfaces:

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

Enclosing class:

MtermvectorsRequest

public static class MtermvectorsRequest.Builder
extends RequestBase.AbstractBuilder<MtermvectorsRequest.Builder>
implements CopyableBuilder<MtermvectorsRequest.Builder,MtermvectorsRequest>

Builder for MtermvectorsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
MtermvectorsRequest	build()	Builds a MtermvectorsRequest.
MtermvectorsRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final MtermvectorsRequest.Builder	docs(Function<MultiTermVectorsOperation.Builder,ObjectBuilder<MultiTermVectorsOperation>> fn)	Array of existing or artificial documents.
final MtermvectorsRequest.Builder	docs(List<MultiTermVectorsOperation> list)	Array of existing or artificial documents.
final MtermvectorsRequest.Builder	docs(MultiTermVectorsOperation value, MultiTermVectorsOperation... values)	Array of existing or artificial documents.
final MtermvectorsRequest.Builder	fields(String value, String... values)	Comma-separated list or wildcard expressions of fields to include in the statistics.
final MtermvectorsRequest.Builder	fields(List<String> list)	Comma-separated list or wildcard expressions of fields to include in the statistics.
final MtermvectorsRequest.Builder	fieldStatistics(Boolean value)	If true, the response includes the document count, sum of document frequencies, and sum of total term frequencies.
final MtermvectorsRequest.Builder	ids(String value, String... values)	Simplified syntax to specify documents by their ID if they're in the same index.
final MtermvectorsRequest.Builder	ids(List<String> list)	Simplified syntax to specify documents by their ID if they're in the same index.
final MtermvectorsRequest.Builder	index(String value)	Name of the index that contains the documents.
final MtermvectorsRequest.Builder	offsets(Boolean value)	If true, the response includes term offsets.
final MtermvectorsRequest.Builder	payloads(Boolean value)	If true, the response includes term payloads.
final MtermvectorsRequest.Builder	positions(Boolean value)	If true, the response includes term positions.
final MtermvectorsRequest.Builder	preference(String value)	Specifies the node or shard the operation should be performed on.
final MtermvectorsRequest.Builder	realtime(Boolean value)	If true, the request is real-time as opposed to near-real-time.
final MtermvectorsRequest.Builder	routing(String value, String... values)	Custom value used to route operations to a specific shard.
final MtermvectorsRequest.Builder	routing(List<String> list)	Custom value used to route operations to a specific shard.
protected MtermvectorsRequest.Builder	self()
final MtermvectorsRequest.Builder	termStatistics(Boolean value)	If true, the response includes term frequency and document frequency.
final MtermvectorsRequest.Builder	version(Long value)	If true, returns the document version as part of a hit.
final MtermvectorsRequest.Builder	versionType(VersionType value)	Specific version type.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder

errorTrace, human

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 MtermvectorsRequest.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<MtermvectorsRequest.Builder,MtermvectorsRequest>

Returns:

a new builder instance.

self

@Nonnull
protected MtermvectorsRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<MtermvectorsRequest.Builder>

docs

@Nonnull
public final MtermvectorsRequest.Builder docs(List<MultiTermVectorsOperation> list)

Array of existing or artificial documents.

API name: docs

Adds all elements of list to docs.

docs

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

Array of existing or artificial documents.

API name: docs

Adds one or more values to docs.

docs

@Nonnull
public final MtermvectorsRequest.Builder docs(Function<MultiTermVectorsOperation.Builder,ObjectBuilder<MultiTermVectorsOperation>> fn)

Array of existing or artificial documents.

API name: docs

Adds a value to docs using a builder lambda.

fieldStatistics

@Nonnull
public final MtermvectorsRequest.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

fields

@Nonnull
public final MtermvectorsRequest.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

@Nonnull
public final MtermvectorsRequest.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.

ids

@Nonnull
public final MtermvectorsRequest.Builder ids(List<String> list)

Simplified syntax to specify documents by their ID if they're in the same index.

API name: ids

Adds all elements of list to ids.

ids

@Nonnull
public final MtermvectorsRequest.Builder ids(String value,
 String... values)

Simplified syntax to specify documents by their ID if they're in the same index.

API name: ids

Adds one or more values to ids.

index

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

Name of the index that contains the documents.

API name: index

offsets

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

If true, the response includes term offsets.

API name: offsets

payloads

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

If true, the response includes term payloads.

API name: payloads

positions

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

If true, the response includes term positions.

API name: positions

preference

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

Specifies the node or shard the operation should be performed on. Random by default.

API name: preference

realtime

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

If true, the request is real-time as opposed to near-real-time.

API name: realtime

routing

@Nonnull
public final MtermvectorsRequest.Builder routing(List<String> list)

Custom value used to route operations to a specific shard.

API name: routing

Adds all elements of list to routing.

routing

@Nonnull
public final MtermvectorsRequest.Builder routing(String value,
 String... values)

Custom value used to route operations to a specific shard.

API name: routing

Adds one or more values to routing.

termStatistics

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

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

API name: term_statistics

version

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

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

API name: version

versionType

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

Specific version type.

API name: version_type

build

@Nonnull
public MtermvectorsRequest build()

Builds a MtermvectorsRequest.

Specified by:

build in interface ObjectBuilder<MtermvectorsRequest>

Throws:

NullPointerException - if some of the required fields are null.