Package org.opensearch.client.opensearch._global

Class MsearchTemplateRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch._global.MsearchTemplateRequest

All Implemented Interfaces:

ToJsonp

public final class MsearchTemplateRequest
extends RequestBase
implements ToJsonp

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<MsearchTemplateRequest>	DESERIALIZER	Json deserializer for MsearchTemplateRequest

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MsearchTemplateRequest(MsearchTemplateRequest.Builder builder)

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	ccsMinimizeRoundtrips()	API name: ccs_minimize_roundtrips
static <TDocument> Endpoint<MsearchTemplateRequest,MsearchTemplateResponse<TDocument>,OpenSearchError>	createMsearchTemplateEndpoint(JsonpDeserializer<TDocument> tDocumentDeserializer)	Create an "msearch_template" endpoint.
java.util.List<java.lang.String>	index()	API name: index
java.lang.Number	maxConcurrentSearches()	API name: max_concurrent_searches
java.lang.Boolean	restTotalHitsAsInt()	API name: rest_total_hits_as_int
jakarta.json.JsonValue	searchType()	API name: search_type
protected static void	setupMsearchTemplateRequestDeserializer(DelegatingDeserializer<MsearchTemplateRequest.Builder> op)
void	toJsonp(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this value to JSON.
java.util.List<java.lang.String>	type()	API name: type
java.lang.Boolean	typedKeys()	API name: typed_keys
java.util.List<TemplateItem>	value()	Request body.

Methods inherited from class java.lang.Object

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

Field Details

DESERIALIZER

public static final JsonpDeserializer<MsearchTemplateRequest> DESERIALIZER

Json deserializer for MsearchTemplateRequest

Constructor Details

MsearchTemplateRequest

protected MsearchTemplateRequest(MsearchTemplateRequest.Builder builder)

Method Details

index

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

API name: index

type

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

API name: type

ccsMinimizeRoundtrips

@Nullable public java.lang.Boolean ccsMinimizeRoundtrips()

API name: ccs_minimize_roundtrips

maxConcurrentSearches

@Nullable public java.lang.Number maxConcurrentSearches()

API name: max_concurrent_searches

searchType

@Nullable public jakarta.json.JsonValue searchType()

API name: search_type

restTotalHitsAsInt

@Nullable public java.lang.Boolean restTotalHitsAsInt()

API name: rest_total_hits_as_int

typedKeys

@Nullable public java.lang.Boolean typedKeys()

API name: typed_keys

value

public java.util.List<TemplateItem> value()

Request body. API name: value

toJsonp

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

Serialize this value to JSON.

Specified by:

toJsonp in interface ToJsonp

setupMsearchTemplateRequestDeserializer

protected static void setupMsearchTemplateRequestDeserializer(DelegatingDeserializer<MsearchTemplateRequest.Builder> op)

createMsearchTemplateEndpoint

public static <TDocument> Endpoint<MsearchTemplateRequest,MsearchTemplateResponse<TDocument>,OpenSearchError> createMsearchTemplateEndpoint(JsonpDeserializer<TDocument> tDocumentDeserializer)

Create an "msearch_template" endpoint.