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 Summary
-
Method Summary
Modifier and TypeMethodDescriptionallowNoIndices
(Boolean value) Iffalse
, the request returns an error if any wildcard expression, index alias, or_all
value targets only missing or closed indices.build()
Builds aSearchTemplateRequest
.ccsMinimizeRoundtrips
(Boolean value) Iftrue
, network round-trips are minimized for cross-cluster search requests.expandWildcards
(ExpandWildcard value, ExpandWildcard... values) Type of index that wildcard patterns can match.expandWildcards
(List<ExpandWildcard> list) Type of index that wildcard patterns can match.Iftrue
, returns detailed information about score calculation as part of each hit.ID of the search template to use.ignoreThrottled
(Boolean value) Iftrue
, specified concrete, expanded, or aliased indices are not included in the response when throttled.ignoreUnavailable
(Boolean value) Iffalse
, the request returns an error if it targets a missing or closed index.Comma-separated list of data streams, indices, and aliases to search.Comma-separated list of data streams, indices, and aliases to search.Key-value pairs used to replace Mustache variables in the template.Key-value pairs used to replace Mustache variables in the template.preference
(String value) Specifies the node or shard the operation should be performed on.Iftrue
, the query execution is profiled.Custom value used to route operations to a specific shard.Specifies how long a consistent view of the index should be maintained for scrolled search.Specifies how long a consistent view of the index should be maintained for scrolled search.searchType
(SearchType value) The type of the search operation.protected SearchTemplateRequest.Builder
self()
An inline search template.Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
allowNoIndices
Iffalse
, 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 targetingfoo*,bar*
returns an error if an index starts withfoo
but no index starts withbar
.API name:
allow_no_indices
-
ccsMinimizeRoundtrips
Iftrue
, network round-trips are minimized for cross-cluster search requests.API name:
ccs_minimize_roundtrips
-
expandWildcards
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 asopen,hidden
. Valid values are:all
,open
,closed
,hidden
,none
.API name:
expand_wildcards
Adds all elements of
list
toexpandWildcards
. -
expandWildcards
public final SearchTemplateRequest.Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values) 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 asopen,hidden
. Valid values are:all
,open
,closed
,hidden
,none
.API name:
expand_wildcards
Adds one or more values to
expandWildcards
. -
explain
Iftrue
, returns detailed information about score calculation as part of each hit.API name:
explain
-
id
ID of the search template to use. If no source is specified, this parameter is required.API name:
id
-
ignoreThrottled
Iftrue
, specified concrete, expanded, or aliased indices are not included in the response when throttled.API name:
ignore_throttled
-
index
Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (*).API name:
index
Adds all elements of
list
toindex
. -
index
Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (*).API name:
index
Adds one or more values to
index
. -
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
Adds all entries of
map
toparams
. -
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
Adds an entry to
params
. -
preference
Specifies the node or shard the operation should be performed on. Random by default.API name:
preference
-
profile
Iftrue
, the query execution is profiled.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
-
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
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<SearchTemplateRequest.Builder>
-
build
Builds aSearchTemplateRequest
.- Specified by:
build
in interfaceObjectBuilder<SearchTemplateRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-