Package org.opensearch.client.opensearch._global

Class TermvectorsRequest<TDocument>

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch._global.TermvectorsRequest<TDocument>

All Implemented Interfaces:

ToJsonp

public final class TermvectorsRequest<TDocument>
extends RequestBase
implements ToJsonp

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TermvectorsRequest.Builder<TDocument>	Builder for TermvectorsRequest.

Field Summary

Fields

Modifier and Type	Field	Description
static Endpoint<TermvectorsRequest<?>,TermvectorsResponse,OpenSearchError>	ENDPOINT	Endpoint "termvectors".

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TermvectorsRequest(TermvectorsRequest.Builder<TDocument> builder)

Method Summary

Modifier and Type	Method	Description
static <TDocument> JsonpDeserializer<TermvectorsRequest<TDocument>>	createTermvectorsRequestDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)	Create a json deserializer for TermvectorsRequest
TDocument	doc()	API name: doc
java.util.List<java.lang.String>	fields()	API name: fields
java.lang.Boolean	fieldStatistics()	API name: field_statistics
Filter	filter()	API name: filter
java.lang.String	id()	API name: id
java.lang.String	index()	API name: index
java.lang.Boolean	offsets()	API name: offsets
java.lang.Boolean	payloads()	API name: payloads
java.util.Map<java.lang.String,java.lang.String>	perFieldAnalyzer()	API name: per_field_analyzer
java.lang.Boolean	positions()	API name: positions
java.lang.String	preference()	API name: preference
java.lang.Boolean	realtime()	API name: realtime
jakarta.json.JsonValue	routing()	API name: routing
protected static <TDocument> void	setupTermvectorsRequestDeserializer(DelegatingDeserializer<TermvectorsRequest.Builder<TDocument>> op, JsonpDeserializer<TDocument> tDocumentDeserializer)
java.lang.Boolean	termStatistics()	API name: term_statistics
void	toJsonp(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	toJsonpInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
java.lang.String	type()	API name: type
java.lang.Number	version()	API name: version
jakarta.json.JsonValue	versionType()	API name: version_type

Methods inherited from class java.lang.Object

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

Field Details

ENDPOINT

public static final Endpoint<TermvectorsRequest<?>,TermvectorsResponse,OpenSearchError> ENDPOINT

Endpoint "termvectors".

Constructor Details

TermvectorsRequest

protected TermvectorsRequest(TermvectorsRequest.Builder<TDocument> builder)

Method Details

index

public java.lang.String index()

API name: index

id

@Nullable public java.lang.String id()

API name: id

type

@Nullable public java.lang.String type()

API name: type

fields

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

API name: fields

fieldStatistics

@Nullable public java.lang.Boolean fieldStatistics()

API name: field_statistics

offsets

@Nullable public java.lang.Boolean offsets()

API name: offsets

payloads

@Nullable public java.lang.Boolean payloads()

API name: payloads

positions

@Nullable public java.lang.Boolean positions()

API name: positions

preference

@Nullable public java.lang.String preference()

API name: preference

realtime

@Nullable public java.lang.Boolean realtime()

API name: realtime

routing

@Nullable public jakarta.json.JsonValue routing()

API name: routing

termStatistics

@Nullable public java.lang.Boolean termStatistics()

API name: term_statistics

version

@Nullable public java.lang.Number version()

API name: version

versionType

@Nullable public jakarta.json.JsonValue versionType()

API name: version_type

doc

@Nullable public TDocument doc()

API name: doc

filter

@Nullable public Filter filter()

API name: filter

perFieldAnalyzer

@Nullable public java.util.Map<java.lang.String,java.lang.String> perFieldAnalyzer()

API name: per_field_analyzer

toJsonp

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

Serialize this object to JSON.

Specified by:

toJsonp in interface ToJsonp

toJsonpInternal

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

createTermvectorsRequestDeserializer

public static <TDocument> JsonpDeserializer<TermvectorsRequest<TDocument>> createTermvectorsRequestDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)

Create a json deserializer for TermvectorsRequest

setupTermvectorsRequestDeserializer

protected static <TDocument> void setupTermvectorsRequestDeserializer(DelegatingDeserializer<TermvectorsRequest.Builder<TDocument>> op, JsonpDeserializer<TDocument> tDocumentDeserializer)