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.BuilderaddIndex(java.lang.String value)Add a value toindex(List), creating the list if needed.SearchTemplateRequest.BuilderaddType(java.lang.String value)Add a value totype(List), creating the list if needed.SearchTemplateRequest.BuilderallowNoIndices(java.lang.Boolean value)API name:allow_no_indicesSearchTemplateRequestbuild()Builds aSearchTemplateRequest.SearchTemplateRequest.BuilderccsMinimizeRoundtrips(java.lang.Boolean value)API name:ccs_minimize_roundtripsSearchTemplateRequest.BuilderexpandWildcards(jakarta.json.JsonValue value)API name:expand_wildcardsSearchTemplateRequest.Builderexplain(java.lang.Boolean value)server_default false API name:explainSearchTemplateRequest.Builderid(java.lang.String value)API name:idSearchTemplateRequest.BuilderignoreThrottled(java.lang.Boolean value)API name:ignore_throttledSearchTemplateRequest.BuilderignoreUnavailable(java.lang.Boolean value)API name:ignore_unavailableSearchTemplateRequest.Builderindex(java.lang.String... value)API name:indexSearchTemplateRequest.Builderindex(java.util.List<java.lang.String> value)API name:indexSearchTemplateRequest.Builderparams(java.util.Map<java.lang.String,jakarta.json.JsonValue> value)API name:paramsSearchTemplateRequest.Builderpreference(java.lang.String value)API name:preferenceSearchTemplateRequest.Builderprofile(java.lang.Boolean value)API name:profileSearchTemplateRequest.BuilderputParams(java.lang.String key, jakarta.json.JsonValue value)Add a key/value toparams(Map), creating the map if needed.SearchTemplateRequest.Builderrouting(jakarta.json.JsonValue value)API name:routingSearchTemplateRequest.Builderscroll(jakarta.json.JsonValue value)API name:scrollSearchTemplateRequest.BuildersearchType(jakarta.json.JsonValue value)API name:search_typeSearchTemplateRequest.Buildersource(java.lang.String value)API name:sourceSearchTemplateRequest.BuildertotalHitsAsInteger(java.lang.Boolean value)If true, hits.total are rendered as an integer in the response.SearchTemplateRequest.Buildertype(java.lang.String... value)API name:typeSearchTemplateRequest.Buildertype(java.util.List<java.lang.String> value)API name:typeSearchTemplateRequest.BuildertypedKeys(java.lang.Boolean value)API name:typed_keys
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
index
API name:index -
index
API name:index -
addIndex
Add a value toindex(List), creating the list if needed. -
type
API name:type -
type
API name:type -
addType
Add a value totype(List), creating the list if needed. -
allowNoIndices
API name:allow_no_indices -
ccsMinimizeRoundtrips
API name:ccs_minimize_roundtrips -
expandWildcards
API name:expand_wildcards -
explain
server_default false API name:explain -
ignoreThrottled
API name:ignore_throttled -
ignoreUnavailable
API name:ignore_unavailable -
preference
API name:preference -
profile
API name:profile -
routing
API name:routing -
scroll
API name:scroll -
searchType
API name:search_type -
totalHitsAsInteger
If true, hits.total are rendered as an integer in the response. API name:total_hits_as_integer -
typedKeys
API name:typed_keys -
id
API name:id -
params
public SearchTemplateRequest.Builder params(@Nullable java.util.Map<java.lang.String,jakarta.json.JsonValue> value)API name:params -
putParams
Add a key/value toparams(Map), creating the map if needed. -
source
API name:source -
build
Builds aSearchTemplateRequest.- Specified by:
buildin interfaceObjectBuilder<SearchTemplateRequest>- Throws:
java.lang.NullPointerException- if some of the required fields are null.
-