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:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SearchTemplateRequest.Builder
Builder forSearchTemplateRequest
.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 JsonpDeserializer<SearchTemplateRequest>
_DESERIALIZER
Json deserializer forSearchTemplateRequest
static SimpleEndpoint<SearchTemplateRequest,?>
_ENDPOINT
Endpoint "search_template
". -
Method Summary
Modifier and Type Method Description java.lang.Boolean
allowNoIndices()
Whether to ignore if a wildcard indices expression resolves into no concrete indices.java.lang.Boolean
ccsMinimizeRoundtrips()
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.java.util.List<ExpandWildcard>
expandWildcards()
Whether to expand wildcard expression to concrete indices that are open, closed or both.java.lang.Boolean
explain()
API name:explain
java.lang.String
id()
ID of the search template to use.java.lang.Boolean
ignoreThrottled()
Whether specified concrete, expanded or aliased indices should be ignored when throttledjava.lang.Boolean
ignoreUnavailable()
Whether specified concrete indices should be ignored when unavailable (missing or closed)java.util.List<java.lang.String>
index()
Comma-separated list of data streams, indices, and aliases to search.static SearchTemplateRequest
of(java.util.function.Function<SearchTemplateRequest.Builder,ObjectBuilder<SearchTemplateRequest>> fn)
java.util.Map<java.lang.String,JsonData>
params()
API name:params
java.lang.String
preference()
Specify the node or shard the operation should be performed on (default: random)java.lang.Boolean
profile()
API name:profile
java.lang.String
routing()
Custom value used to route operations to a specific shard.Time
scroll()
Specifies how long a consistent view of the index should be maintained for scrolled search.SearchType
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
setupSearchTemplateRequestDeserializer(ObjectDeserializer<SearchTemplateRequest.Builder> op)
java.lang.String
source()
An inline search template.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
Json deserializer forSearchTemplateRequest
-
_ENDPOINT
Endpoint "search_template
".
-
-
Method Details
-
of
public static SearchTemplateRequest of(java.util.function.Function<SearchTemplateRequest.Builder,ObjectBuilder<SearchTemplateRequest>> fn) -
allowNoIndices
@Nullable public final java.lang.Boolean 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
@Nullable public final java.lang.Boolean 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
@Nullable public final java.lang.Boolean explain()API name:explain
-
id
@Nullable public final java.lang.String id()ID of the search template to use. If no source is specified, this parameter is required.API name:
id
-
ignoreThrottled
@Nullable public final java.lang.Boolean ignoreThrottled()Whether specified concrete, expanded or aliased indices should be ignored when throttledAPI name:
ignore_throttled
-
index
public final java.util.List<java.lang.String> index()Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (*).API name:
index
-
params
API name:params
-
preference
@Nullable public final java.lang.String preference()Specify the node or shard the operation should be performed on (default: random)API name:
preference
-
profile
@Nullable public final java.lang.Boolean profile()API name:profile
-
routing
@Nullable public final java.lang.String 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
@Nullable public final java.lang.String 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>,ErrorResponse> createSearchTemplateEndpoint(JsonpDeserializer<TDocument> tDocumentDeserializer)Create an "search_template
" endpoint.
-