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

Class MultiTermVectorsOperation

java.lang.Object

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

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<MultiTermVectorsOperation.Builder,MultiTermVectorsOperation>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class MultiTermVectorsOperation
extends Object
implements PlainJsonSerializable, ToCopyableBuilder<MultiTermVectorsOperation.Builder,MultiTermVectorsOperation>

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<MultiTermVectorsOperation>	_DESERIALIZER	Json deserializer for MultiTermVectorsOperation

Method Summary

Modifier and Type	Method	Description
static MultiTermVectorsOperation.Builder	builder()
final JsonData	doc()	An artificial document for which you want to retrieve term vectors.
boolean	equals(Object o)
final List<String>	fields()	API name: fields
final Boolean	fieldStatistics()	When true, the response includes the document count, the sum of the document frequencies, and the sum of the term frequencies.
final Filter	filter()	API name: filter
int	hashCode()
final String	id()	Required - API name: _id
final String	index()	API name: _index
static MultiTermVectorsOperation	of(Function<MultiTermVectorsOperation.Builder,ObjectBuilder<MultiTermVectorsOperation>> fn)
final Boolean	offsets()	When true, the response includes the term offsets.
final Boolean	payloads()	When true, the response includes the term payloads.
final Boolean	positions()	When true, the response includes the term positions.
final String	routing()	API name: routing
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	setupMultiTermVectorsOperationDeserializer(ObjectDeserializer<MultiTermVectorsOperation.Builder> op)
final Boolean	termStatistics()	When true, the response includes the term frequency and the document frequency.
MultiTermVectorsOperation.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final Long	version()	API name: version
final VersionType	versionType()	API name: version_type

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

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

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<MultiTermVectorsOperation> _DESERIALIZER

Json deserializer for MultiTermVectorsOperation

Method Details

of

public static MultiTermVectorsOperation of(Function<MultiTermVectorsOperation.Builder,ObjectBuilder<MultiTermVectorsOperation>> fn)

doc

@Nullable
public final JsonData doc()

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

API name: doc

fieldStatistics

@Nullable
public final Boolean fieldStatistics()

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 List<String> fields()

API name: fields

filter

@Nullable
public final Filter filter()

API name: filter

id

@Nonnull
public final String id()

Required - API name: _id

index

@Nullable
public final String index()

API name: _index

offsets

@Nullable
public final Boolean offsets()

When true, the response includes the term offsets.

API name: offsets

payloads

@Nullable
public final Boolean payloads()

When true, the response includes the term payloads.

API name: payloads

positions

@Nullable
public final Boolean positions()

When true, the response includes the term positions.

API name: positions

routing

@Nullable
public final String routing()

API name: routing

termStatistics

@Nullable
public final Boolean termStatistics()

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

API name: term_statistics

version

@Nullable
public final Long version()

API name: version

versionType

@Nullable
public final VersionType versionType()

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

@Nonnull
public MultiTermVectorsOperation.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<MultiTermVectorsOperation.Builder,MultiTermVectorsOperation>

Returns:

a new builder instance.

builder

@Nonnull
public static MultiTermVectorsOperation.Builder builder()

setupMultiTermVectorsOperationDeserializer

protected static void setupMultiTermVectorsOperationDeserializer(ObjectDeserializer<MultiTermVectorsOperation.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object