Package co.elastic.clients.elasticsearch.core

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
Run a search with a search template.
See Also:

  • Field Details

  • Method Details

    • of

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

    • allowNoIndices

      @Nullable public final Boolean allowNoIndices()
      If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.

      API name: allow_no_indices

    • ccsMinimizeRoundtrips

      @Nullable public final Boolean ccsMinimizeRoundtrips()
      If true, network round-trips are minimized for cross-cluster search requests.

      API name: ccs_minimize_roundtrips

    • expandWildcards

      public final List<ExpandWildcard> expandWildcards()
      The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

      API name: expand_wildcards

    • explain

      @Nullable public final Boolean explain()
      If true, returns detailed information about score calculation as part of each hit. If you specify both this and the explain query parameter, the API uses only the query parameter.

      API name: explain

    • id

      @Nullable public final String id()
      The ID of the search template to use. If no source is specified, this parameter is required.

      API name: id

    • ignoreThrottled

      @Deprecated @Nullable public final Boolean ignoreThrottled()
      Deprecated.
      7.16.0
      If true, specified concrete, expanded, or aliased indices are not included in the response when throttled.

      API name: ignore_throttled

    • ignoreUnavailable

      @Nullable public final Boolean ignoreUnavailable()
      If false, the request returns an error if it targets a missing or closed index.

      API name: ignore_unavailable

    • index

      public final List<String> index()
      A comma-separated list of data streams, indices, and aliases to search. It supports wildcards (*).

      API name: index

    • params

      public final Map<String,JsonData> params()
      Key-value pairs used to replace Mustache variables in the template. The key is the variable name. The value is the variable value.

      API name: params

    • preference

      @Nullable public final String preference()
      The node or shard the operation should be performed on. It is random by default.

      API name: preference

    • profile

      @Nullable public final Boolean profile()
      If true, the query execution is profiled.

      API name: profile

    • projectRouting

      @Nullable public final String projectRouting()
      Specifies a subset of projects to target for the search using project metadata tags in a subset of Lucene query syntax. Allowed Lucene queries: the _alias tag and a single value (possibly wildcarded). Examples: _alias:my-project _alias:_origin _alias:pr Supported in serverless only.

      API name: project_routing

    • routing

      @Nullable public final String routing()
      A custom value used to route operations to a specific shard.

      API name: routing

    • scroll

      @Nullable public final Time scroll()
      Specifies how long a consistent view of the index should be maintained for scrolled search.

      API name: scroll

    • searchType

      @Nullable public final SearchType searchType()
      The type of the search operation.

      API name: search_type

    • source

      @Nullable public final ScriptSource source()
      An inline search template. Supports the same parameters as the search API's request body. It also supports Mustache variables. If no id is specified, this parameter is required.

      API name: source

    • 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)

    • 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.