Package org.opensearch.client.opensearch.core

Class SearchTemplateRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.SearchTemplateRequest.Builder

All Implemented Interfaces:

ObjectBuilder<SearchTemplateRequest>

Enclosing class:

SearchTemplateRequest

public static class SearchTemplateRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<SearchTemplateRequest>

Builder for SearchTemplateRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final SearchTemplateRequest.Builder	allowNoIndices(Boolean value)	Whether to ignore if a wildcard indices expression resolves into no concrete indices.
SearchTemplateRequest	build()	Builds a SearchTemplateRequest.
final SearchTemplateRequest.Builder	ccsMinimizeRoundtrips(Boolean value)	Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
final SearchTemplateRequest.Builder	expandWildcards(List<ExpandWildcard> list)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
final SearchTemplateRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
final SearchTemplateRequest.Builder	explain(Boolean value)	API name: explain
final SearchTemplateRequest.Builder	id(String value)	ID of the search template to use.
final SearchTemplateRequest.Builder	ignoreThrottled(Boolean value)	Whether specified concrete, expanded or aliased indices should be ignored when throttled
final SearchTemplateRequest.Builder	ignoreUnavailable(Boolean value)	Whether specified concrete indices should be ignored when unavailable (missing or closed)
final SearchTemplateRequest.Builder	index(String value, String... values)	Comma-separated list of data streams, indices, and aliases to search.
final SearchTemplateRequest.Builder	index(List<String> list)	Comma-separated list of data streams, indices, and aliases to search.
final SearchTemplateRequest.Builder	params(String key, JsonData value)	API name: params
final SearchTemplateRequest.Builder	params(Map<String,JsonData> map)	API name: params
final SearchTemplateRequest.Builder	phaseTook(Boolean value)	Indicates whether search phase took times should be returned in SearchResponse
final SearchTemplateRequest.Builder	pipeline(String value)	Specifies search pipeline name
final SearchTemplateRequest.Builder	preference(String value)	Specify the node or shard the operation should be performed on (default: random)
final SearchTemplateRequest.Builder	profile(Boolean value)	API name: profile
final SearchTemplateRequest.Builder	routing(String value)	Custom value used to route operations to a specific shard.
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.
final SearchTemplateRequest.Builder	scroll(Time value)	Specifies how long a consistent view of the index should be maintained for scrolled search.
final SearchTemplateRequest.Builder	searchType(SearchType value)	The type of the search operation.
final SearchTemplateRequest.Builder	source(String value)	An inline search template.

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

allowNoIndices

public final SearchTemplateRequest.Builder allowNoIndices(@Nullable
 Boolean value)

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

public final SearchTemplateRequest.Builder ccsMinimizeRoundtrips(@Nullable
 Boolean value)

Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution

API name: ccs_minimize_roundtrips

phaseTook

public final SearchTemplateRequest.Builder phaseTook(@Nullable
 Boolean value)

Indicates whether search phase took times should be returned in SearchResponse

API name: phase_took

pipeline

public final SearchTemplateRequest.Builder pipeline(@Nullable
 String value)

Specifies search pipeline name

API name: pipeline

expandWildcards

public final SearchTemplateRequest.Builder expandWildcards(List<ExpandWildcard> list)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

API name: expand_wildcards

Adds all elements of list to expandWildcards.

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

public final SearchTemplateRequest.Builder explain(@Nullable
 Boolean value)

API name: explain

id

public final SearchTemplateRequest.Builder id(@Nullable
 String value)

ID of the search template to use. If no source is specified, this parameter is required.

API name: id

ignoreThrottled

public final SearchTemplateRequest.Builder ignoreThrottled(@Nullable
 Boolean value)

Whether specified concrete, expanded or aliased indices should be ignored when throttled

API name: ignore_throttled

ignoreUnavailable

public final SearchTemplateRequest.Builder ignoreUnavailable(@Nullable
 Boolean value)

Whether specified concrete indices should be ignored when unavailable (missing or closed)

API name: ignore_unavailable

index

public final SearchTemplateRequest.Builder index(List<String> list)

Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (*).

API name: index

Adds all elements of list to index.

index

public final SearchTemplateRequest.Builder index(String value,
 String... values)

Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (*).

API name: index

Adds one or more values to index.

params

public final SearchTemplateRequest.Builder params(Map<String,JsonData> map)

API name: params

Adds all entries of map to params.

params

public final SearchTemplateRequest.Builder params(String key,
 JsonData value)

API name: params

Adds an entry to params.

preference

public final SearchTemplateRequest.Builder preference(@Nullable
 String value)

Specify the node or shard the operation should be performed on (default: random)

API name: preference

profile

public final SearchTemplateRequest.Builder profile(@Nullable
 Boolean value)

API name: profile

routing

public final SearchTemplateRequest.Builder routing(@Nullable
 String value)

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
 String value)

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

build

public SearchTemplateRequest build()

Builds a SearchTemplateRequest.

Specified by:

build in interface ObjectBuilder<SearchTemplateRequest>

Throws:

NullPointerException - if some of the required fields are null.