Class SearchTemplateRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.core.SearchTemplateRequest
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class SearchTemplateRequest
extends RequestBase
implements JsonpSerializable
Allows to use the Mustache language to pre-render a search definition.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<SearchTemplateRequest>
Json deserializer forSearchTemplateRequest
static final SimpleEndpoint<SearchTemplateRequest,
?> Endpoint "search_template
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Whether to ignore if a wildcard indices expression resolves into no concrete indices.final Boolean
Indicates whether network round-trips should be minimized as part of cross-cluster search requests executionstatic <TDocument>
Endpoint<SearchTemplateRequest,SearchTemplateResponse<TDocument>, ErrorResponse> createSearchTemplateEndpoint
(JsonpDeserializer<TDocument> tDocumentDeserializer) Create an "search_template
" endpoint.final List<ExpandWildcard>
Whether to expand wildcard expression to concrete indices that are open, closed or both.final Boolean
explain()
API name:explain
final String
id()
ID of the search template to use.final Boolean
Whether specified concrete, expanded or aliased indices should be ignored when throttledfinal Boolean
Whether specified concrete indices should be ignored when unavailable (missing or closed)index()
Comma-separated list of data streams, indices, and aliases to search.static SearchTemplateRequest
params()
API name:params
final String
Specify the node or shard the operation should be performed on (default: random)final Boolean
profile()
API name:profile
final String
routing()
Custom value used to route operations to a specific shard.final Time
scroll()
Specifies how long a consistent view of the index should be maintained for scrolled search.final SearchType
The type of the search operation.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
final String
source()
An inline search template.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_DESERIALIZER
Json deserializer forSearchTemplateRequest
-
_ENDPOINT
Endpoint "search_template
".
-
-
Method Details
-
of
public static SearchTemplateRequest of(Function<SearchTemplateRequest.Builder, ObjectBuilder<SearchTemplateRequest>> fn) -
allowNoIndices
Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes_all
string or when no indices have been specified)API name:
allow_no_indices
-
ccsMinimizeRoundtrips
Indicates whether network round-trips should be minimized as part of cross-cluster search requests executionAPI name:
ccs_minimize_roundtrips
-
expandWildcards
Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
-
explain
API name:explain
-
id
ID of the search template to use. If no source is specified, this parameter is required.API name:
id
-
ignoreThrottled
Whether specified concrete, expanded or aliased indices should be ignored when throttledAPI name:
ignore_throttled
-
index
Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (*).API name:
index
-
params
API name:params
-
preference
Specify the node or shard the operation should be performed on (default: random)API name:
preference
-
profile
API name:profile
-
routing
Custom value used to route operations to a specific shard.API name:
routing
-
scroll
Specifies how long a consistent view of the index should be maintained for scrolled search.API name:
scroll
-
searchType
The type of the search operation.API name:
search_type
-
source
An inline search template. Supports the same parameters as the search API's request body. Also supports Mustache variables. If no id is specified, this parameter is required.API name:
source
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupSearchTemplateRequestDeserializer
protected static void setupSearchTemplateRequestDeserializer(ObjectDeserializer<SearchTemplateRequest.Builder> op) -
createSearchTemplateEndpoint
public static <TDocument> Endpoint<SearchTemplateRequest,SearchTemplateResponse<TDocument>, createSearchTemplateEndpointErrorResponse> (JsonpDeserializer<TDocument> tDocumentDeserializer) Create an "search_template
" endpoint.
-