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.Builder
addFields(jakarta.json.JsonValue value)
Add a value tofields(List)
, creating the list if needed.SearchRequest.Builder
addIndex(java.lang.String value)
Add a value toindex(List)
, creating the list if needed.SearchRequest.Builder
addIndicesBoost(java.util.Map<java.lang.String,java.lang.Number> value)
Add a value toindicesBoost(List)
, creating the list if needed.SearchRequest.Builder
addRescore(java.util.function.Function<Rescore.Builder,ObjectBuilder<Rescore>> fn)
Add a value torescore(List)
, creating the list if needed.SearchRequest.Builder
addRescore(Rescore value)
Add a value torescore(List)
, creating the list if needed.SearchRequest.Builder
addSearchAfter(jakarta.json.JsonValue value)
Add a value tosearchAfter(List)
, creating the list if needed.SearchRequest.Builder
addSort(jakarta.json.JsonValue value)
Add a value tosort(List)
, creating the list if needed.SearchRequest.Builder
addSourceExcludes(java.lang.String value)
Add a value tosourceExcludes(List)
, creating the list if needed.SearchRequest.Builder
addSourceIncludes(java.lang.String value)
Add a value tosourceIncludes(List)
, creating the list if needed.SearchRequest.Builder
addStats(java.lang.String value)
Add a value tostats(List)
, creating the list if needed.SearchRequest.Builder
addStoredFields(java.lang.String value)
Add a value tostoredFields(List)
, creating the list if needed.SearchRequest.Builder
addType(java.lang.String value)
Add a value totype(List)
, creating the list if needed.SearchRequest.Builder
aggregations(java.lang.String key, java.util.function.Function<AggregationContainer.Builder,ObjectBuilder<AggregationContainer>> fn)
Setaggregations(Map)
to a singleton map.SearchRequest.Builder
aggregations(java.util.Map<java.lang.String,AggregationContainer> value)
API name:aggregations
SearchRequest.Builder
aggs(java.lang.String key, java.util.function.Function<AggregationContainer.Builder,ObjectBuilder<AggregationContainer>> fn)
Setaggs(Map)
to a singleton map.SearchRequest.Builder
aggs(java.util.Map<java.lang.String,AggregationContainer> value)
API name:aggs
SearchRequest.Builder
allowNoIndices(java.lang.Boolean value)
API name:allow_no_indices
SearchRequest.Builder
allowPartialSearchResults(java.lang.Boolean value)
API name:allow_partial_search_results
SearchRequest.Builder
analyzer(java.lang.String value)
API name:analyzer
SearchRequest.Builder
analyzeWildcard(java.lang.Boolean value)
API name:analyze_wildcard
SearchRequest.Builder
batchedReduceSize(java.lang.Number value)
API name:batched_reduce_size
SearchRequest
build()
Builds aSearchRequest
.SearchRequest.Builder
ccsMinimizeRoundtrips(java.lang.Boolean value)
API name:ccs_minimize_roundtrips
SearchRequest.Builder
collapse(java.util.function.Function<FieldCollapse.Builder,ObjectBuilder<FieldCollapse>> fn)
API name:collapse
SearchRequest.Builder
collapse(FieldCollapse value)
API name:collapse
SearchRequest.Builder
defaultOperator(jakarta.json.JsonValue value)
API name:default_operator
SearchRequest.Builder
df(java.lang.String value)
API name:df
SearchRequest.Builder
docvalueFields(jakarta.json.JsonValue value)
API name:docvalue_fields
SearchRequest.Builder
expandWildcards(jakarta.json.JsonValue value)
API name:expand_wildcards
SearchRequest.Builder
explain(java.lang.Boolean value)
API name:explain
SearchRequest.Builder
fields(jakarta.json.JsonValue... value)
API name:fields
SearchRequest.Builder
fields(java.util.List<jakarta.json.JsonValue> value)
API name:fields
SearchRequest.Builder
from(java.lang.Number value)
API name:from
SearchRequest.Builder
highlight(java.util.function.Function<Highlight.Builder,ObjectBuilder<Highlight>> fn)
API name:highlight
SearchRequest.Builder
highlight(Highlight value)
API name:highlight
SearchRequest.Builder
ignoreThrottled(java.lang.Boolean value)
API name:ignore_throttled
SearchRequest.Builder
ignoreUnavailable(java.lang.Boolean value)
API name:ignore_unavailable
SearchRequest.Builder
index(java.lang.String... value)
API name:index
SearchRequest.Builder
index(java.util.List<java.lang.String> value)
API name:index
SearchRequest.Builder
indicesBoost(java.util.List<java.util.Map<java.lang.String,java.lang.Number>> value)
API name:indices_boost
SearchRequest.Builder
indicesBoost(java.util.Map<java.lang.String,java.lang.Number>... value)
API name:indices_boost
SearchRequest.Builder
lenient(java.lang.Boolean value)
API name:lenient
SearchRequest.Builder
maxConcurrentShardRequests(java.lang.Number value)
API name:max_concurrent_shard_requests
SearchRequest.Builder
minCompatibleShardNode(java.lang.String value)
API name:min_compatible_shard_node
SearchRequest.Builder
minScore(java.lang.Number value)
API name:min_score
SearchRequest.Builder
pit(java.util.function.Function<PointInTimeReference.Builder,ObjectBuilder<PointInTimeReference>> fn)
API name:pit
SearchRequest.Builder
pit(PointInTimeReference value)
API name:pit
SearchRequest.Builder
postFilter(java.util.function.Function<QueryContainer.Builder,ObjectBuilder<QueryContainer>> fn)
API name:post_filter
SearchRequest.Builder
postFilter(QueryContainer value)
API name:post_filter
SearchRequest.Builder
preference(java.lang.String value)
API name:preference
SearchRequest.Builder
preFilterShardSize(java.lang.Number value)
API name:pre_filter_shard_size
SearchRequest.Builder
profile(java.lang.Boolean value)
API name:profile
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.SearchRequest.Builder
putAggregations(java.lang.String key, AggregationContainer value)
Add a key/value toaggregations(Map)
, creating the map if needed.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.SearchRequest.Builder
putAggs(java.lang.String key, AggregationContainer value)
Add a key/value toaggs(Map)
, creating the map if needed.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.SearchRequest.Builder
putRuntimeMappings(java.lang.String key, RuntimeField value)
Add a key/value toruntimeMappings(Map)
, creating the map if needed.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.SearchRequest.Builder
putScriptFields(java.lang.String key, ScriptField value)
Add a key/value toscriptFields(Map)
, creating the map if needed.SearchRequest.Builder
q(java.lang.String value)
API name:q
SearchRequest.Builder
query(java.util.function.Function<QueryContainer.Builder,ObjectBuilder<QueryContainer>> fn)
API name:query
SearchRequest.Builder
query(QueryContainer value)
API name:query
SearchRequest.Builder
requestCache(java.lang.Boolean value)
API name:request_cache
SearchRequest.Builder
rescore(java.util.function.Function<Rescore.Builder,ObjectBuilder<Rescore>> fn)
Setrescore(List)
to a singleton list.SearchRequest.Builder
rescore(java.util.List<Rescore> value)
API name:rescore
SearchRequest.Builder
rescore(Rescore... value)
API name:rescore
SearchRequest.Builder
restTotalHitsAsInt(java.lang.Boolean value)
API name:rest_total_hits_as_int
SearchRequest.Builder
routing(jakarta.json.JsonValue value)
API name:routing
SearchRequest.Builder
runtimeMappings(java.lang.String key, java.util.function.Function<RuntimeField.Builder,ObjectBuilder<RuntimeField>> fn)
SetruntimeMappings(Map)
to a singleton map.SearchRequest.Builder
runtimeMappings(java.util.Map<java.lang.String,RuntimeField> value)
API name:runtime_mappings
SearchRequest.Builder
scriptFields(java.lang.String key, java.util.function.Function<ScriptField.Builder,ObjectBuilder<ScriptField>> fn)
SetscriptFields(Map)
to a singleton map.SearchRequest.Builder
scriptFields(java.util.Map<java.lang.String,ScriptField> value)
API name:script_fields
SearchRequest.Builder
scroll(jakarta.json.JsonValue value)
API name:scroll
SearchRequest.Builder
searchAfter(jakarta.json.JsonValue... value)
API name:search_after
SearchRequest.Builder
searchAfter(java.util.List<jakarta.json.JsonValue> value)
API name:search_after
SearchRequest.Builder
searchType(jakarta.json.JsonValue value)
API name:search_type
SearchRequest.Builder
seqNoPrimaryTerm(java.lang.Boolean value)
API name:seq_no_primary_term
SearchRequest.Builder
size(java.lang.Number value)
API name:size
SearchRequest.Builder
slice(java.util.function.Function<SlicedScroll.Builder,ObjectBuilder<SlicedScroll>> fn)
API name:slice
SearchRequest.Builder
slice(SlicedScroll value)
API name:slice
SearchRequest.Builder
sort(jakarta.json.JsonValue... value)
API name:sort
SearchRequest.Builder
sort(java.util.List<jakarta.json.JsonValue> value)
API name:sort
SearchRequest.Builder
source(jakarta.json.JsonValue value)
API name:_source
SearchRequest.Builder
sourceExcludes(java.lang.String... value)
API name:_source_excludes
SearchRequest.Builder
sourceExcludes(java.util.List<java.lang.String> value)
API name:_source_excludes
SearchRequest.Builder
sourceIncludes(java.lang.String... value)
API name:_source_includes
SearchRequest.Builder
sourceIncludes(java.util.List<java.lang.String> value)
API name:_source_includes
SearchRequest.Builder
stats(java.lang.String... value)
API name:stats
SearchRequest.Builder
stats(java.util.List<java.lang.String> value)
API name:stats
SearchRequest.Builder
storedFields(java.lang.String... value)
API name:stored_fields
SearchRequest.Builder
storedFields(java.util.List<java.lang.String> value)
API name:stored_fields
SearchRequest.Builder
suggest(jakarta.json.JsonValue value)
API name:suggest
SearchRequest.Builder
suggestField(java.lang.String value)
API name:suggest_field
SearchRequest.Builder
suggestMode(jakarta.json.JsonValue value)
API name:suggest_mode
SearchRequest.Builder
suggestSize(java.lang.Number value)
API name:suggest_size
SearchRequest.Builder
suggestText(java.lang.String value)
API name:suggest_text
SearchRequest.Builder
terminateAfter(java.lang.Number value)
API name:terminate_after
SearchRequest.Builder
timeout(java.lang.String value)
API name:timeout
SearchRequest.Builder
trackScores(java.lang.Boolean value)
API name:track_scores
SearchRequest.Builder
trackTotalHits(jakarta.json.JsonValue value)
API name:track_total_hits
SearchRequest.Builder
type(java.lang.String... value)
API name:type
SearchRequest.Builder
type(java.util.List<java.lang.String> value)
API name:type
SearchRequest.Builder
typedKeys(java.lang.Boolean value)
API name:typed_keys
SearchRequest.Builder
version(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:
build
in interfaceObjectBuilder<SearchRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-