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) Whether to ignore if a wildcard indices expression resolves into no concrete indices.build()
Builds aSearchTemplateRequest
.ccsMinimizeRoundtrips
(Boolean value) Indicates whether network round-trips should be minimized as part of cross-cluster search requests executionexpandWildcards
(ExpandWildcard value, ExpandWildcard... values) Whether to expand wildcard expression to concrete indices that are open, closed or both.expandWildcards
(List<ExpandWildcard> list) Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:explain
ID of the search template to use.ignoreThrottled
(Boolean value) Whether specified concrete, expanded or aliased indices should be ignored when throttledignoreUnavailable
(Boolean value) Whether specified concrete indices should be ignored when unavailable (missing or closed)Comma-separated list of data streams, indices, and aliases to search.Comma-separated list of data streams, indices, and aliases to search.API name:params
API name:params
preference
(String value) Specify the node or shard the operation should be performed on (default: random)API name:profile
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
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
Adds all elements of
list
toexpandWildcards
. -
expandWildcards
public final SearchTemplateRequest.Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values) Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
Adds one or more values to
expandWildcards
. -
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
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
API name:params
Adds all entries of
map
toparams
. -
params
API name:params
Adds an entry to
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
-
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.
-