Package co.elastic.clients.elasticsearch.core

Class SearchTemplateRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<SearchTemplateRequest.Builder>
co.elastic.clients.elasticsearch.core.SearchTemplateRequest.Builder
All Implemented Interfaces:
WithJson<SearchTemplateRequest.Builder>, ObjectBuilder<SearchTemplateRequest>
Enclosing class:
SearchTemplateRequest
public static class SearchTemplateRequest.Builder extends RequestBase.AbstractBuilder<SearchTemplateRequest.Builder> implements ObjectBuilder<SearchTemplateRequest>
Builder for SearchTemplateRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allowNoIndices

      public final SearchTemplateRequest.Builder allowNoIndices(@Nullable Boolean value)
      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

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

      API name: ccs_minimize_roundtrips

    • expandWildcards

      public final SearchTemplateRequest.Builder expandWildcards(List<ExpandWildcard> list)
      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

      Adds all elements of list to expandWildcards.

    • expandWildcards

      public final SearchTemplateRequest.Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values)
      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

      Adds one or more values to expandWildcards.

    • explain

      public final SearchTemplateRequest.Builder explain(@Nullable Boolean value)
      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

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

      API name: id

    • ignoreThrottled

      @Deprecated public final SearchTemplateRequest.Builder ignoreThrottled(@Nullable Boolean value)
      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

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

      API name: ignore_unavailable

    • index

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

      API name: index

      Adds all elements of list to index.

    • index

      public final SearchTemplateRequest.Builder index(String value, String... values)
      A comma-separated list of data streams, indices, and aliases to search. It supports wildcards (*).

      API name: index

      Adds one or more values to index.

    • params

      public final SearchTemplateRequest.Builder params(Map<String,JsonData> map)
      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

      Adds all entries of map to params.

    • params

      public final SearchTemplateRequest.Builder params(String key, JsonData value)
      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

      Adds an entry to params.

    • preference

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

      API name: preference

    • profile

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

      API name: profile

    • projectRouting

      public final SearchTemplateRequest.Builder projectRouting(@Nullable String value)
      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

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

      API name: routing

    • scroll

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

      API name: scroll

    • scroll

      public final SearchTemplateRequest.Builder scroll(Function<Time.Builder,ObjectBuilder<Time>> fn)
      Specifies how long a consistent view of the index should be maintained for scrolled search.

      API name: scroll

    • searchType

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

      API name: search_type

    • source

      public final SearchTemplateRequest.Builder source(@Nullable ScriptSource value)
      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

    • source

      public final SearchTemplateRequest.Builder source(Function<ScriptSource.Builder,ObjectBuilder<ScriptSource>> fn)
      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

    • self

      protected SearchTemplateRequest.Builder self()
      Specified by:
      self in class RequestBase.AbstractBuilder<SearchTemplateRequest.Builder>

    • build

      public SearchTemplateRequest build()
      Builds a SearchTemplateRequest.
      Specified by:
      build in interface ObjectBuilder<SearchTemplateRequest>
      Throws:
      NullPointerException - if some of the required fields are null.