Package org.opensearch.client.opensearch.core

Class MtermvectorsRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.core.MtermvectorsRequest

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable

@JsonpDeserializable
public class MtermvectorsRequest
extends RequestBase
implements PlainJsonSerializable

Returns multiple termvectors in one request.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MtermvectorsRequest.Builder	Builder for MtermvectorsRequest.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<MtermvectorsRequest>	_DESERIALIZER	Json deserializer for MtermvectorsRequest
static Endpoint<MtermvectorsRequest,MtermvectorsResponse,ErrorResponse>	_ENDPOINT	Endpoint "mtermvectors".

Method Summary

Modifier and Type	Method	Description
java.util.List<MultiTermVectorsOperation>	docs()	API name: docs
java.util.List<java.lang.String>	fields()	A comma-separated list of fields to return.
java.lang.Boolean	fieldStatistics()	Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.
java.util.List<java.lang.String>	ids()	API name: ids
java.lang.String	index()	The index in which the document resides.
static MtermvectorsRequest	of(java.util.function.Function<MtermvectorsRequest.Builder,ObjectBuilder<MtermvectorsRequest>> fn)
java.lang.Boolean	offsets()	Specifies if term offsets should be returned.
java.lang.Boolean	payloads()	Specifies if term payloads should be returned.
java.lang.Boolean	positions()	Specifies if term positions should be returned.
java.lang.String	preference()	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".
java.lang.Boolean	realtime()	Specifies if requests are real-time as opposed to near-real-time (default: true).
java.lang.String	routing()	Specific routing value.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupMtermvectorsRequestDeserializer(ObjectDeserializer<MtermvectorsRequest.Builder> op)
java.lang.Boolean	termStatistics()	Specifies if total term frequency and document frequency should be returned.
MtermvectorsRequest.Builder	toBuilder()
java.lang.Long	version()	Explicit version number for concurrency control
VersionType	versionType()	Specific version type

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.json.PlainJsonSerializable

toJsonString

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<MtermvectorsRequest> _DESERIALIZER

Json deserializer for MtermvectorsRequest

_ENDPOINT

public static final Endpoint<MtermvectorsRequest,MtermvectorsResponse,ErrorResponse> _ENDPOINT

Endpoint "mtermvectors".

Method Detail

of

public static MtermvectorsRequest of(java.util.function.Function<MtermvectorsRequest.Builder,ObjectBuilder<MtermvectorsRequest>> fn)

docs

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

API name: docs

fieldStatistics

@Nullable
public final java.lang.Boolean fieldStatistics()

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 java.util.List<java.lang.String> fields()

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

API name: fields

ids

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

API name: ids

index

@Nullable
public final java.lang.String index()

The index in which the document resides.

API name: index

offsets

@Nullable
public final java.lang.Boolean offsets()

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

API name: offsets

payloads

@Nullable
public final java.lang.Boolean payloads()

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

API name: payloads

positions

@Nullable
public final java.lang.Boolean positions()

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

API name: positions

preference

@Nullable
public final java.lang.String preference()

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

@Nullable
public final java.lang.Boolean realtime()

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

API name: realtime

routing

@Nullable
public final java.lang.String routing()

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

API name: routing

termStatistics

@Nullable
public final java.lang.Boolean termStatistics()

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

@Nullable
public final java.lang.Long version()

Explicit version number for concurrency control

API name: version

versionType

@Nullable
public final VersionType versionType()

Specific version type

API name: version_type

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
                      JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
                                 JsonpMapper mapper)

toBuilder

public MtermvectorsRequest.Builder toBuilder()

setupMtermvectorsRequestDeserializer

protected static void setupMtermvectorsRequestDeserializer(ObjectDeserializer<MtermvectorsRequest.Builder> op)