Package org.opensearch.client.opensearch._global

Class SearchTemplateRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch._global.SearchTemplateRequest

All Implemented Interfaces:

ToJsonp

public final class SearchTemplateRequest
extends RequestBase
implements ToJsonp

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SearchTemplateRequest(SearchTemplateRequest.Builder builder)

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	allowNoIndices()	API name: allow_no_indices
java.lang.Boolean	ccsMinimizeRoundtrips()	API name: ccs_minimize_roundtrips
static <TDocument> Endpoint<SearchTemplateRequest,SearchTemplateResponse<TDocument>,OpenSearchError>	createSearchTemplateEndpoint(JsonpDeserializer<TDocument> tDocumentDeserializer)	Create an "search_template" endpoint.
jakarta.json.JsonValue	expandWildcards()	API name: expand_wildcards
java.lang.Boolean	explain()	server_default false API name: explain
java.lang.String	id()	API name: id
java.lang.Boolean	ignoreThrottled()	API name: ignore_throttled
java.lang.Boolean	ignoreUnavailable()	API name: ignore_unavailable
java.util.List<java.lang.String>	index()	API name: index
java.util.Map<java.lang.String,jakarta.json.JsonValue>	params()	API name: params
java.lang.String	preference()	API name: preference
java.lang.Boolean	profile()	API name: profile
jakarta.json.JsonValue	routing()	API name: routing
jakarta.json.JsonValue	scroll()	API name: scroll
jakarta.json.JsonValue	searchType()	API name: search_type
protected static void	setupSearchTemplateRequestDeserializer(DelegatingDeserializer<SearchTemplateRequest.Builder> op)
java.lang.String	source()	API name: source
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.Boolean	totalHitsAsInteger()	If true, hits.total are rendered as an integer in the response.
java.util.List<java.lang.String>	type()	API name: type
java.lang.Boolean	typedKeys()	API name: typed_keys

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<SearchTemplateRequest> DESERIALIZER

Json deserializer for SearchTemplateRequest

Constructor Details

SearchTemplateRequest

protected SearchTemplateRequest(SearchTemplateRequest.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

allowNoIndices

@Nullable public java.lang.Boolean allowNoIndices()

API name: allow_no_indices

ccsMinimizeRoundtrips

@Nullable public java.lang.Boolean ccsMinimizeRoundtrips()

API name: ccs_minimize_roundtrips

expandWildcards

@Nullable public jakarta.json.JsonValue expandWildcards()

API name: expand_wildcards

explain

@Nullable public java.lang.Boolean explain()

server_default false API name: explain

ignoreThrottled

@Nullable public java.lang.Boolean ignoreThrottled()

API name: ignore_throttled

ignoreUnavailable

@Nullable public java.lang.Boolean ignoreUnavailable()

API name: ignore_unavailable

preference

@Nullable public java.lang.String preference()

API name: preference

profile

@Nullable public java.lang.Boolean profile()

API name: profile

routing

@Nullable public jakarta.json.JsonValue routing()

API name: routing

scroll

@Nullable public jakarta.json.JsonValue scroll()

API name: scroll

searchType

@Nullable public jakarta.json.JsonValue searchType()

API name: search_type

totalHitsAsInteger

@Nullable public java.lang.Boolean totalHitsAsInteger()

If true, hits.total are rendered as an integer in the response. API name: total_hits_as_integer

typedKeys

@Nullable public java.lang.Boolean typedKeys()

API name: typed_keys

id

@Nullable public java.lang.String id()

API name: id

params

@Nullable public java.util.Map<java.lang.String,jakarta.json.JsonValue> params()

API name: params

source

@Nullable public java.lang.String source()

API name: source

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)

setupSearchTemplateRequestDeserializer

protected static void setupSearchTemplateRequestDeserializer(DelegatingDeserializer<SearchTemplateRequest.Builder> op)

createSearchTemplateEndpoint

public static <TDocument> Endpoint<SearchTemplateRequest,SearchTemplateResponse<TDocument>,OpenSearchError> createSearchTemplateEndpoint(JsonpDeserializer<TDocument> tDocumentDeserializer)

Create an "search_template" endpoint.