Package org.opensearch.client.opensearch._global

Class SearchTemplateRequest.Builder

java.lang.Object

org.opensearch.client.opensearch._global.SearchTemplateRequest.Builder

All Implemented Interfaces:

ObjectBuilder<SearchTemplateRequest>

Enclosing class:

SearchTemplateRequest

public static class SearchTemplateRequest.Builder
extends java.lang.Object
implements ObjectBuilder<SearchTemplateRequest>

Builder for SearchTemplateRequest.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SearchTemplateRequest.Builder	addIndex(java.lang.String value)	Add a value to index(List), creating the list if needed.
SearchTemplateRequest.Builder	addType(java.lang.String value)	Add a value to type(List), creating the list if needed.
SearchTemplateRequest.Builder	allowNoIndices(java.lang.Boolean value)	API name: allow_no_indices
SearchTemplateRequest	build()	Builds a SearchTemplateRequest.
SearchTemplateRequest.Builder	ccsMinimizeRoundtrips(java.lang.Boolean value)	API name: ccs_minimize_roundtrips
SearchTemplateRequest.Builder	expandWildcards(jakarta.json.JsonValue value)	API name: expand_wildcards
SearchTemplateRequest.Builder	explain(java.lang.Boolean value)	server_default false API name: explain
SearchTemplateRequest.Builder	id(java.lang.String value)	API name: id
SearchTemplateRequest.Builder	ignoreThrottled(java.lang.Boolean value)	API name: ignore_throttled
SearchTemplateRequest.Builder	ignoreUnavailable(java.lang.Boolean value)	API name: ignore_unavailable
SearchTemplateRequest.Builder	index(java.lang.String... value)	API name: index
SearchTemplateRequest.Builder	index(java.util.List<java.lang.String> value)	API name: index
SearchTemplateRequest.Builder	params(java.util.Map<java.lang.String,jakarta.json.JsonValue> value)	API name: params
SearchTemplateRequest.Builder	preference(java.lang.String value)	API name: preference
SearchTemplateRequest.Builder	profile(java.lang.Boolean value)	API name: profile
SearchTemplateRequest.Builder	putParams(java.lang.String key, jakarta.json.JsonValue value)	Add a key/value to params(Map), creating the map if needed.
SearchTemplateRequest.Builder	routing(jakarta.json.JsonValue value)	API name: routing
SearchTemplateRequest.Builder	scroll(jakarta.json.JsonValue value)	API name: scroll
SearchTemplateRequest.Builder	searchType(jakarta.json.JsonValue value)	API name: search_type
SearchTemplateRequest.Builder	source(java.lang.String value)	API name: source
SearchTemplateRequest.Builder	totalHitsAsInteger(java.lang.Boolean value)	If true, hits.total are rendered as an integer in the response.
SearchTemplateRequest.Builder	type(java.lang.String... value)	API name: type
SearchTemplateRequest.Builder	type(java.util.List<java.lang.String> value)	API name: type
SearchTemplateRequest.Builder	typedKeys(java.lang.Boolean value)	API name: typed_keys

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

index

public SearchTemplateRequest.Builder index(@Nullable java.util.List<java.lang.String> value)

API name: index

index

public SearchTemplateRequest.Builder index(java.lang.String... value)

API name: index

addIndex

public SearchTemplateRequest.Builder addIndex(java.lang.String value)

Add a value to index(List), creating the list if needed.

type

public SearchTemplateRequest.Builder type(@Nullable java.util.List<java.lang.String> value)

API name: type

type

public SearchTemplateRequest.Builder type(java.lang.String... value)

API name: type

addType

public SearchTemplateRequest.Builder addType(java.lang.String value)

Add a value to type(List), creating the list if needed.

allowNoIndices

public SearchTemplateRequest.Builder allowNoIndices(@Nullable java.lang.Boolean value)

API name: allow_no_indices

ccsMinimizeRoundtrips

public SearchTemplateRequest.Builder ccsMinimizeRoundtrips(@Nullable java.lang.Boolean value)

API name: ccs_minimize_roundtrips

expandWildcards

public SearchTemplateRequest.Builder expandWildcards(@Nullable jakarta.json.JsonValue value)

API name: expand_wildcards

explain

public SearchTemplateRequest.Builder explain(@Nullable java.lang.Boolean value)

server_default false API name: explain

ignoreThrottled

public SearchTemplateRequest.Builder ignoreThrottled(@Nullable java.lang.Boolean value)

API name: ignore_throttled

ignoreUnavailable

public SearchTemplateRequest.Builder ignoreUnavailable(@Nullable java.lang.Boolean value)

API name: ignore_unavailable

preference

public SearchTemplateRequest.Builder preference(@Nullable java.lang.String value)

API name: preference

profile

public SearchTemplateRequest.Builder profile(@Nullable java.lang.Boolean value)

API name: profile

routing

public SearchTemplateRequest.Builder routing(@Nullable jakarta.json.JsonValue value)

API name: routing

scroll

public SearchTemplateRequest.Builder scroll(@Nullable jakarta.json.JsonValue value)

API name: scroll

searchType

public SearchTemplateRequest.Builder searchType(@Nullable jakarta.json.JsonValue value)

API name: search_type

totalHitsAsInteger

public SearchTemplateRequest.Builder totalHitsAsInteger(@Nullable java.lang.Boolean value)

If true, hits.total are rendered as an integer in the response. API name: total_hits_as_integer

typedKeys

public SearchTemplateRequest.Builder typedKeys(@Nullable java.lang.Boolean value)

API name: typed_keys

id

public SearchTemplateRequest.Builder id(@Nullable java.lang.String value)

API name: id

params

public SearchTemplateRequest.Builder params(@Nullable java.util.Map<java.lang.String,jakarta.json.JsonValue> value)

API name: params

putParams

public SearchTemplateRequest.Builder putParams(java.lang.String key, jakarta.json.JsonValue value)

Add a key/value to params(Map), creating the map if needed.

source

public SearchTemplateRequest.Builder source(@Nullable java.lang.String value)

API name: source

build

public SearchTemplateRequest build()

Builds a SearchTemplateRequest.

Specified by:

build in interface ObjectBuilder<SearchTemplateRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.