Class SearchRequest.Builder
java.lang.Object
org.opensearch.client.opensearch._global.SearchRequest.Builder
- All Implemented Interfaces:
ObjectBuilder<SearchRequest>
- Enclosing class:
- SearchRequest
public static class SearchRequest.Builder extends java.lang.Object implements ObjectBuilder<SearchRequest>
Builder for
SearchRequest.-
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 SearchRequest.BuilderaddFields(jakarta.json.JsonValue value)Add a value tofields(List), creating the list if needed.SearchRequest.BuilderaddIndex(java.lang.String value)Add a value toindex(List), creating the list if needed.SearchRequest.BuilderaddIndicesBoost(java.util.Map<java.lang.String,java.lang.Number> value)Add a value toindicesBoost(List), creating the list if needed.SearchRequest.BuilderaddRescore(java.util.function.Function<Rescore.Builder,ObjectBuilder<Rescore>> fn)Add a value torescore(List), creating the list if needed.SearchRequest.BuilderaddRescore(Rescore value)Add a value torescore(List), creating the list if needed.SearchRequest.BuilderaddSearchAfter(jakarta.json.JsonValue value)Add a value tosearchAfter(List), creating the list if needed.SearchRequest.BuilderaddSort(jakarta.json.JsonValue value)Add a value tosort(List), creating the list if needed.SearchRequest.BuilderaddSourceExcludes(java.lang.String value)Add a value tosourceExcludes(List), creating the list if needed.SearchRequest.BuilderaddSourceIncludes(java.lang.String value)Add a value tosourceIncludes(List), creating the list if needed.SearchRequest.BuilderaddStats(java.lang.String value)Add a value tostats(List), creating the list if needed.SearchRequest.BuilderaddStoredFields(java.lang.String value)Add a value tostoredFields(List), creating the list if needed.SearchRequest.BuilderaddType(java.lang.String value)Add a value totype(List), creating the list if needed.SearchRequest.Builderaggregations(java.lang.String key, java.util.function.Function<AggregationContainer.Builder,ObjectBuilder<AggregationContainer>> fn)Setaggregations(Map)to a singleton map.SearchRequest.Builderaggregations(java.util.Map<java.lang.String,AggregationContainer> value)API name:aggregationsSearchRequest.Builderaggs(java.lang.String key, java.util.function.Function<AggregationContainer.Builder,ObjectBuilder<AggregationContainer>> fn)Setaggs(Map)to a singleton map.SearchRequest.Builderaggs(java.util.Map<java.lang.String,AggregationContainer> value)API name:aggsSearchRequest.BuilderallowNoIndices(java.lang.Boolean value)API name:allow_no_indicesSearchRequest.BuilderallowPartialSearchResults(java.lang.Boolean value)API name:allow_partial_search_resultsSearchRequest.Builderanalyzer(java.lang.String value)API name:analyzerSearchRequest.BuilderanalyzeWildcard(java.lang.Boolean value)API name:analyze_wildcardSearchRequest.BuilderbatchedReduceSize(java.lang.Number value)API name:batched_reduce_sizeSearchRequestbuild()Builds aSearchRequest.SearchRequest.BuilderccsMinimizeRoundtrips(java.lang.Boolean value)API name:ccs_minimize_roundtripsSearchRequest.Buildercollapse(java.util.function.Function<FieldCollapse.Builder,ObjectBuilder<FieldCollapse>> fn)API name:collapseSearchRequest.Buildercollapse(FieldCollapse value)API name:collapseSearchRequest.BuilderdefaultOperator(jakarta.json.JsonValue value)API name:default_operatorSearchRequest.Builderdf(java.lang.String value)API name:dfSearchRequest.BuilderdocvalueFields(jakarta.json.JsonValue value)API name:docvalue_fieldsSearchRequest.BuilderexpandWildcards(jakarta.json.JsonValue value)API name:expand_wildcardsSearchRequest.Builderexplain(java.lang.Boolean value)API name:explainSearchRequest.Builderfields(jakarta.json.JsonValue... value)API name:fieldsSearchRequest.Builderfields(java.util.List<jakarta.json.JsonValue> value)API name:fieldsSearchRequest.Builderfrom(java.lang.Number value)API name:fromSearchRequest.Builderhighlight(java.util.function.Function<Highlight.Builder,ObjectBuilder<Highlight>> fn)API name:highlightSearchRequest.Builderhighlight(Highlight value)API name:highlightSearchRequest.BuilderignoreThrottled(java.lang.Boolean value)API name:ignore_throttledSearchRequest.BuilderignoreUnavailable(java.lang.Boolean value)API name:ignore_unavailableSearchRequest.Builderindex(java.lang.String... value)API name:indexSearchRequest.Builderindex(java.util.List<java.lang.String> value)API name:indexSearchRequest.BuilderindicesBoost(java.util.List<java.util.Map<java.lang.String,java.lang.Number>> value)API name:indices_boostSearchRequest.BuilderindicesBoost(java.util.Map<java.lang.String,java.lang.Number>... value)API name:indices_boostSearchRequest.Builderlenient(java.lang.Boolean value)API name:lenientSearchRequest.BuildermaxConcurrentShardRequests(java.lang.Number value)API name:max_concurrent_shard_requestsSearchRequest.BuilderminCompatibleShardNode(java.lang.String value)API name:min_compatible_shard_nodeSearchRequest.BuilderminScore(java.lang.Number value)API name:min_scoreSearchRequest.Builderpit(java.util.function.Function<PointInTimeReference.Builder,ObjectBuilder<PointInTimeReference>> fn)API name:pitSearchRequest.Builderpit(PointInTimeReference value)API name:pitSearchRequest.BuilderpostFilter(java.util.function.Function<QueryContainer.Builder,ObjectBuilder<QueryContainer>> fn)API name:post_filterSearchRequest.BuilderpostFilter(QueryContainer value)API name:post_filterSearchRequest.Builderpreference(java.lang.String value)API name:preferenceSearchRequest.BuilderpreFilterShardSize(java.lang.Number value)API name:pre_filter_shard_sizeSearchRequest.Builderprofile(java.lang.Boolean value)API name:profileSearchRequest.BuilderputAggregations(java.lang.String key, java.util.function.Function<AggregationContainer.Builder,ObjectBuilder<AggregationContainer>> fn)Add a key/value toaggregations(Map), creating the map if needed.SearchRequest.BuilderputAggregations(java.lang.String key, AggregationContainer value)Add a key/value toaggregations(Map), creating the map if needed.SearchRequest.BuilderputAggs(java.lang.String key, java.util.function.Function<AggregationContainer.Builder,ObjectBuilder<AggregationContainer>> fn)Add a key/value toaggs(Map), creating the map if needed.SearchRequest.BuilderputAggs(java.lang.String key, AggregationContainer value)Add a key/value toaggs(Map), creating the map if needed.SearchRequest.BuilderputRuntimeMappings(java.lang.String key, java.util.function.Function<RuntimeField.Builder,ObjectBuilder<RuntimeField>> fn)Add a key/value toruntimeMappings(Map), creating the map if needed.SearchRequest.BuilderputRuntimeMappings(java.lang.String key, RuntimeField value)Add a key/value toruntimeMappings(Map), creating the map if needed.SearchRequest.BuilderputScriptFields(java.lang.String key, java.util.function.Function<ScriptField.Builder,ObjectBuilder<ScriptField>> fn)Add a key/value toscriptFields(Map), creating the map if needed.SearchRequest.BuilderputScriptFields(java.lang.String key, ScriptField value)Add a key/value toscriptFields(Map), creating the map if needed.SearchRequest.Builderq(java.lang.String value)API name:qSearchRequest.Builderquery(java.util.function.Function<QueryContainer.Builder,ObjectBuilder<QueryContainer>> fn)API name:querySearchRequest.Builderquery(QueryContainer value)API name:querySearchRequest.BuilderrequestCache(java.lang.Boolean value)API name:request_cacheSearchRequest.Builderrescore(java.util.function.Function<Rescore.Builder,ObjectBuilder<Rescore>> fn)Setrescore(List)to a singleton list.SearchRequest.Builderrescore(java.util.List<Rescore> value)API name:rescoreSearchRequest.Builderrescore(Rescore... value)API name:rescoreSearchRequest.BuilderrestTotalHitsAsInt(java.lang.Boolean value)API name:rest_total_hits_as_intSearchRequest.Builderrouting(jakarta.json.JsonValue value)API name:routingSearchRequest.BuilderruntimeMappings(java.lang.String key, java.util.function.Function<RuntimeField.Builder,ObjectBuilder<RuntimeField>> fn)SetruntimeMappings(Map)to a singleton map.SearchRequest.BuilderruntimeMappings(java.util.Map<java.lang.String,RuntimeField> value)API name:runtime_mappingsSearchRequest.BuilderscriptFields(java.lang.String key, java.util.function.Function<ScriptField.Builder,ObjectBuilder<ScriptField>> fn)SetscriptFields(Map)to a singleton map.SearchRequest.BuilderscriptFields(java.util.Map<java.lang.String,ScriptField> value)API name:script_fieldsSearchRequest.Builderscroll(jakarta.json.JsonValue value)API name:scrollSearchRequest.BuildersearchAfter(jakarta.json.JsonValue... value)API name:search_afterSearchRequest.BuildersearchAfter(java.util.List<jakarta.json.JsonValue> value)API name:search_afterSearchRequest.BuildersearchType(jakarta.json.JsonValue value)API name:search_typeSearchRequest.BuilderseqNoPrimaryTerm(java.lang.Boolean value)API name:seq_no_primary_termSearchRequest.Buildersize(java.lang.Number value)API name:sizeSearchRequest.Builderslice(java.util.function.Function<SlicedScroll.Builder,ObjectBuilder<SlicedScroll>> fn)API name:sliceSearchRequest.Builderslice(SlicedScroll value)API name:sliceSearchRequest.Buildersort(jakarta.json.JsonValue... value)API name:sortSearchRequest.Buildersort(java.util.List<jakarta.json.JsonValue> value)API name:sortSearchRequest.Buildersource(jakarta.json.JsonValue value)API name:_sourceSearchRequest.BuildersourceExcludes(java.lang.String... value)API name:_source_excludesSearchRequest.BuildersourceExcludes(java.util.List<java.lang.String> value)API name:_source_excludesSearchRequest.BuildersourceIncludes(java.lang.String... value)API name:_source_includesSearchRequest.BuildersourceIncludes(java.util.List<java.lang.String> value)API name:_source_includesSearchRequest.Builderstats(java.lang.String... value)API name:statsSearchRequest.Builderstats(java.util.List<java.lang.String> value)API name:statsSearchRequest.BuilderstoredFields(java.lang.String... value)API name:stored_fieldsSearchRequest.BuilderstoredFields(java.util.List<java.lang.String> value)API name:stored_fieldsSearchRequest.Buildersuggest(jakarta.json.JsonValue value)API name:suggestSearchRequest.BuildersuggestField(java.lang.String value)API name:suggest_fieldSearchRequest.BuildersuggestMode(jakarta.json.JsonValue value)API name:suggest_modeSearchRequest.BuildersuggestSize(java.lang.Number value)API name:suggest_sizeSearchRequest.BuildersuggestText(java.lang.String value)API name:suggest_textSearchRequest.BuilderterminateAfter(java.lang.Number value)API name:terminate_afterSearchRequest.Buildertimeout(java.lang.String value)API name:timeoutSearchRequest.BuildertrackScores(java.lang.Boolean value)API name:track_scoresSearchRequest.BuildertrackTotalHits(jakarta.json.JsonValue value)API name:track_total_hitsSearchRequest.Buildertype(java.lang.String... value)API name:typeSearchRequest.Buildertype(java.util.List<java.lang.String> value)API name:typeSearchRequest.BuildertypedKeys(java.lang.Boolean value)API name:typed_keysSearchRequest.Builderversion(java.lang.Boolean value)API name:version
-
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 -
allowPartialSearchResults
API name:allow_partial_search_results -
analyzer
API name:analyzer -
analyzeWildcard
API name:analyze_wildcard -
batchedReduceSize
API name:batched_reduce_size -
ccsMinimizeRoundtrips
API name:ccs_minimize_roundtrips -
defaultOperator
API name:default_operator -
df
API name:df -
expandWildcards
API name:expand_wildcards -
ignoreThrottled
API name:ignore_throttled -
ignoreUnavailable
API name:ignore_unavailable -
lenient
API name:lenient -
maxConcurrentShardRequests
API name:max_concurrent_shard_requests -
minCompatibleShardNode
API name:min_compatible_shard_node -
preference
API name:preference -
preFilterShardSize
API name:pre_filter_shard_size -
requestCache
API name:request_cache -
routing
API name:routing -
scroll
API name:scroll -
searchType
API name:search_type -
suggestField
API name:suggest_field -
suggestMode
API name:suggest_mode -
suggestSize
API name:suggest_size -
suggestText
API name:suggest_text -
typedKeys
API name:typed_keys -
restTotalHitsAsInt
API name:rest_total_hits_as_int -
sourceExcludes
API name:_source_excludes -
sourceExcludes
API name:_source_excludes -
addSourceExcludes
Add a value tosourceExcludes(List), creating the list if needed. -
sourceIncludes
API name:_source_includes -
sourceIncludes
API name:_source_includes -
addSourceIncludes
Add a value tosourceIncludes(List), creating the list if needed. -
q
API name:q -
aggs
public SearchRequest.Builder aggs(@Nullable java.util.Map<java.lang.String,AggregationContainer> value)API name:aggs -
putAggs
Add a key/value toaggs(Map), creating the map if needed. -
aggs
public SearchRequest.Builder aggs(java.lang.String key, java.util.function.Function<AggregationContainer.Builder,ObjectBuilder<AggregationContainer>> fn)Setaggs(Map)to a singleton map. -
putAggs
public SearchRequest.Builder putAggs(java.lang.String key, java.util.function.Function<AggregationContainer.Builder,ObjectBuilder<AggregationContainer>> fn)Add a key/value toaggs(Map), creating the map if needed. -
aggregations
public SearchRequest.Builder aggregations(@Nullable java.util.Map<java.lang.String,AggregationContainer> value)API name:aggregations -
putAggregations
Add a key/value toaggregations(Map), creating the map if needed. -
aggregations
public SearchRequest.Builder aggregations(java.lang.String key, java.util.function.Function<AggregationContainer.Builder,ObjectBuilder<AggregationContainer>> fn)Setaggregations(Map)to a singleton map. -
putAggregations
public SearchRequest.Builder putAggregations(java.lang.String key, java.util.function.Function<AggregationContainer.Builder,ObjectBuilder<AggregationContainer>> fn)Add a key/value toaggregations(Map), creating the map if needed. -
collapse
API name:collapse -
collapse
public SearchRequest.Builder collapse(java.util.function.Function<FieldCollapse.Builder,ObjectBuilder<FieldCollapse>> fn)API name:collapse -
explain
API name:explain -
from
API name:from -
highlight
API name:highlight -
highlight
public SearchRequest.Builder highlight(java.util.function.Function<Highlight.Builder,ObjectBuilder<Highlight>> fn)API name:highlight -
trackTotalHits
API name:track_total_hits -
indicesBoost
public SearchRequest.Builder indicesBoost(@Nullable java.util.List<java.util.Map<java.lang.String,java.lang.Number>> value)API name:indices_boost -
indicesBoost
public SearchRequest.Builder indicesBoost(java.util.Map<java.lang.String,java.lang.Number>... value)API name:indices_boost -
addIndicesBoost
public SearchRequest.Builder addIndicesBoost(java.util.Map<java.lang.String,java.lang.Number> value)Add a value toindicesBoost(List), creating the list if needed. -
docvalueFields
API name:docvalue_fields -
minScore
API name:min_score -
postFilter
API name:post_filter -
postFilter
public SearchRequest.Builder postFilter(java.util.function.Function<QueryContainer.Builder,ObjectBuilder<QueryContainer>> fn)API name:post_filter -
profile
API name:profile -
query
API name:query -
query
public SearchRequest.Builder query(java.util.function.Function<QueryContainer.Builder,ObjectBuilder<QueryContainer>> fn)API name:query -
rescore
API name:rescore -
rescore
API name:rescore -
addRescore
Add a value torescore(List), creating the list if needed. -
rescore
public SearchRequest.Builder rescore(java.util.function.Function<Rescore.Builder,ObjectBuilder<Rescore>> fn)Setrescore(List)to a singleton list. -
addRescore
public SearchRequest.Builder addRescore(java.util.function.Function<Rescore.Builder,ObjectBuilder<Rescore>> fn)Add a value torescore(List), creating the list if needed. -
scriptFields
public SearchRequest.Builder scriptFields(@Nullable java.util.Map<java.lang.String,ScriptField> value)API name:script_fields -
putScriptFields
Add a key/value toscriptFields(Map), creating the map if needed. -
scriptFields
public SearchRequest.Builder scriptFields(java.lang.String key, java.util.function.Function<ScriptField.Builder,ObjectBuilder<ScriptField>> fn)SetscriptFields(Map)to a singleton map. -
putScriptFields
public SearchRequest.Builder putScriptFields(java.lang.String key, java.util.function.Function<ScriptField.Builder,ObjectBuilder<ScriptField>> fn)Add a key/value toscriptFields(Map), creating the map if needed. -
searchAfter
API name:search_after -
searchAfter
API name:search_after -
addSearchAfter
Add a value tosearchAfter(List), creating the list if needed. -
size
API name:size -
slice
API name:slice -
slice
public SearchRequest.Builder slice(java.util.function.Function<SlicedScroll.Builder,ObjectBuilder<SlicedScroll>> fn)API name:slice -
sort
API name:sort -
sort
API name:sort -
addSort
Add a value tosort(List), creating the list if needed. -
source
API name:_source -
fields
API name:fields -
fields
API name:fields -
addFields
Add a value tofields(List), creating the list if needed. -
suggest
API name:suggest -
terminateAfter
API name:terminate_after -
timeout
API name:timeout -
trackScores
API name:track_scores -
version
API name:version -
seqNoPrimaryTerm
API name:seq_no_primary_term -
storedFields
API name:stored_fields -
storedFields
API name:stored_fields -
addStoredFields
Add a value tostoredFields(List), creating the list if needed. -
pit
API name:pit -
pit
public SearchRequest.Builder pit(java.util.function.Function<PointInTimeReference.Builder,ObjectBuilder<PointInTimeReference>> fn)API name:pit -
runtimeMappings
public SearchRequest.Builder runtimeMappings(@Nullable java.util.Map<java.lang.String,RuntimeField> value)API name:runtime_mappings -
putRuntimeMappings
Add a key/value toruntimeMappings(Map), creating the map if needed. -
runtimeMappings
public SearchRequest.Builder runtimeMappings(java.lang.String key, java.util.function.Function<RuntimeField.Builder,ObjectBuilder<RuntimeField>> fn)SetruntimeMappings(Map)to a singleton map. -
putRuntimeMappings
public SearchRequest.Builder putRuntimeMappings(java.lang.String key, java.util.function.Function<RuntimeField.Builder,ObjectBuilder<RuntimeField>> fn)Add a key/value toruntimeMappings(Map), creating the map if needed. -
stats
API name:stats -
stats
API name:stats -
addStats
Add a value tostats(List), creating the list if needed. -
build
Builds aSearchRequest.- Specified by:
buildin interfaceObjectBuilder<SearchRequest>- Throws:
java.lang.NullPointerException- if some of the required fields are null.
-