Package co.elastic.clients.elasticsearch.search_application

Class SearchApplicationSearchRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.search_application.SearchApplicationSearchRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class SearchApplicationSearchRequest
extends RequestBase
implements JsonpSerializable

Run a search application search. Generate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template. Unspecified template parameters are assigned their default values if applicable.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

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

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<SearchApplicationSearchRequest>	_DESERIALIZER	Json deserializer for SearchApplicationSearchRequest
static final SimpleEndpoint<SearchApplicationSearchRequest,?>	_ENDPOINT	Endpoint "search_application.search".

Method Summary

Modifier and Type	Method	Description
static <TDocument> Endpoint<SearchApplicationSearchRequest,SearchApplicationSearchResponse<TDocument>,ErrorResponse>	createSearchEndpoint(JsonpDeserializer<TDocument> tDocumentDeserializer)	Create an "search_application.search" endpoint.
final String	name()	Required - The name of the search application to be searched.
static SearchApplicationSearchRequest	of(Function<SearchApplicationSearchRequest.Builder,ObjectBuilder<SearchApplicationSearchRequest>> fn)
final Map<String,JsonData>	params()	Query parameters specific to this request, which will override any defaults specified in the template.
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	setupSearchApplicationSearchRequestDeserializer(ObjectDeserializer<SearchApplicationSearchRequest.Builder> op)

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<SearchApplicationSearchRequest> _DESERIALIZER

Json deserializer for SearchApplicationSearchRequest

_ENDPOINT

public static final SimpleEndpoint<SearchApplicationSearchRequest,?> _ENDPOINT

Endpoint "search_application.search".

Method Details

of

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

name

public final String name()

Required - The name of the search application to be searched.

API name: name

params

public final Map<String,JsonData> params()

Query parameters specific to this request, which will override any defaults specified in the template.

API name: params

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)

setupSearchApplicationSearchRequestDeserializer

protected static void setupSearchApplicationSearchRequestDeserializer(ObjectDeserializer<SearchApplicationSearchRequest.Builder> op)

createSearchEndpoint

public static <TDocument>
Endpoint<SearchApplicationSearchRequest,SearchApplicationSearchResponse<TDocument>,ErrorResponse> createSearchEndpoint(JsonpDeserializer<TDocument> tDocumentDeserializer)

Create an "search_application.search" endpoint.