Class SubmitRequest.Builder
java.lang.Object
co.elastic.clients.elasticsearch.async_search.SubmitRequest.Builder
- All Implemented Interfaces:
ObjectBuilder<SubmitRequest>
- Enclosing class:
- SubmitRequest
public static class SubmitRequest.Builder extends java.lang.Object implements ObjectBuilder<SubmitRequest>
Builder for
SubmitRequest.-
Constructor Summary
Constructors Constructor Description Builder() -
Method Summary
Modifier and Type Method Description SubmitRequest.BuilderaddDocvalueFields(java.lang.String value)Add a value todocvalueFields(List), creating the list if needed.SubmitRequest.BuilderaddExpandWildcards(ExpandWildcardOptions value)Add a value toexpandWildcards(List), creating the list if needed.SubmitRequest.BuilderaddFields(jakarta.json.JsonValue value)Add a value tofields(List), creating the list if needed.SubmitRequest.BuilderaddIndex(java.lang.String value)Add a value toindex(List), creating the list if needed.SubmitRequest.BuilderaddIndicesBoost(java.util.Map<java.lang.String,java.lang.Double> value)Add a value toindicesBoost(List), creating the list if needed.SubmitRequest.BuilderaddRescore(Rescore value)Add a value torescore(List), creating the list if needed.SubmitRequest.BuilderaddRescore(java.util.function.Function<Rescore.Builder,ObjectBuilder<Rescore>> fn)Add a value torescore(List), creating the list if needed.SubmitRequest.BuilderaddSearchAfter(java.lang.String value)Add a value tosearchAfter(List), creating the list if needed.SubmitRequest.BuilderaddSort(jakarta.json.JsonValue value)Add a value tosort(List), creating the list if needed.SubmitRequest.BuilderaddStats(java.lang.String value)Add a value tostats(List), creating the list if needed.SubmitRequest.BuilderaddStoredFields(java.lang.String value)Add a value tostoredFields(List), creating the list if needed.SubmitRequest.Builderaggs(java.lang.String key, java.util.function.Function<Aggregation.Builder,ObjectBuilder<Aggregation>> fn)Setaggs(Map)to a singleton map.SubmitRequest.Builderaggs(java.util.Map<java.lang.String,Aggregation> value)API name:aggsSubmitRequest.BuilderallowNoIndices(java.lang.Boolean value)API name:allow_no_indicesSubmitRequest.BuilderallowPartialSearchResults(java.lang.Boolean value)API name:allow_partial_search_resultsSubmitRequest.Builderanalyzer(java.lang.String value)API name:analyzerSubmitRequest.BuilderanalyzeWildcard(java.lang.Boolean value)API name:analyze_wildcardSubmitRequest.BuilderbatchedReduceSize(java.lang.Long value)The number of shard results that should be reduced at once on the coordinating node.SubmitRequestbuild()Builds aSubmitRequest.SubmitRequest.Buildercollapse(FieldCollapse value)API name:collapseSubmitRequest.Buildercollapse(java.util.function.Function<FieldCollapse.Builder,ObjectBuilder<FieldCollapse>> fn)API name:collapseSubmitRequest.BuilderdefaultOperator(DefaultOperator value)API name:default_operatorSubmitRequest.Builderdf(java.lang.String value)API name:dfSubmitRequest.BuilderdocvalueFields(java.lang.String... value)API name:docvalue_fieldsSubmitRequest.BuilderdocvalueFields(java.util.List<java.lang.String> value)API name:docvalue_fieldsSubmitRequest.BuilderexpandWildcards(ExpandWildcardOptions... value)API name:expand_wildcardsSubmitRequest.BuilderexpandWildcards(java.util.List<ExpandWildcardOptions> value)API name:expand_wildcardsSubmitRequest.Builderexplain(java.lang.Boolean value)API name:explainSubmitRequest.Builderfields(jakarta.json.JsonValue... value)API name:fieldsSubmitRequest.Builderfields(java.util.List<jakarta.json.JsonValue> value)API name:fieldsSubmitRequest.Builderfrom(java.lang.Integer value)API name:fromSubmitRequest.Builderhighlight(Highlight value)API name:highlightSubmitRequest.Builderhighlight(java.util.function.Function<Highlight.Builder,ObjectBuilder<Highlight>> fn)API name:highlightSubmitRequest.BuilderignoreThrottled(java.lang.Boolean value)API name:ignore_throttledSubmitRequest.BuilderignoreUnavailable(java.lang.Boolean value)API name:ignore_unavailableSubmitRequest.Builderindex(java.lang.String... value)A comma-separated list of index names to search; use_allor empty string to perform the operation on all indicesSubmitRequest.Builderindex(java.util.List<java.lang.String> value)A comma-separated list of index names to search; use_allor empty string to perform the operation on all indicesSubmitRequest.BuilderindicesBoost(java.util.List<java.util.Map<java.lang.String,java.lang.Double>> value)API name:indices_boostSubmitRequest.BuilderindicesBoost(java.util.Map<java.lang.String,java.lang.Double>... value)API name:indices_boostSubmitRequest.BuilderkeepAlive(java.lang.String value)API name:keep_aliveSubmitRequest.BuilderkeepOnCompletion(java.lang.Boolean value)Control whether the response should be stored in the cluster if it completed within the provided [wait_for_completion] time (default: false)SubmitRequest.Builderlenient(java.lang.Boolean value)API name:lenientSubmitRequest.BuildermaxConcurrentShardRequests(java.lang.Long value)API name:max_concurrent_shard_requestsSubmitRequest.BuilderminScore(java.lang.Double value)API name:min_scoreSubmitRequest.Builderpit(PointInTimeReference value)API name:pitSubmitRequest.Builderpit(java.util.function.Function<PointInTimeReference.Builder,ObjectBuilder<PointInTimeReference>> fn)API name:pitSubmitRequest.BuilderpostFilter(Query value)API name:post_filterSubmitRequest.BuilderpostFilter(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)API name:post_filterSubmitRequest.Builderpreference(java.lang.String value)API name:preferenceSubmitRequest.Builderprofile(java.lang.Boolean value)API name:profileSubmitRequest.BuilderputAggs(java.lang.String key, Aggregation value)Add a key/value toaggs(Map), creating the map if needed.SubmitRequest.BuilderputAggs(java.lang.String key, java.util.function.Function<Aggregation.Builder,ObjectBuilder<Aggregation>> fn)Add a key/value toaggs(Map), creating the map if needed.SubmitRequest.BuilderputRuntimeMappings(java.lang.String key, RuntimeField value)Add a key/value toruntimeMappings(Map), creating the map if needed.SubmitRequest.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.SubmitRequest.BuilderputScriptFields(java.lang.String key, ScriptField value)Add a key/value toscriptFields(Map), creating the map if needed.SubmitRequest.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.SubmitRequest.BuilderputSuggest(java.lang.String key, Suggest value)Add a key/value tosuggest(Map), creating the map if needed.SubmitRequest.BuilderputSuggest(java.lang.String key, java.util.function.Function<Suggest.Builder,ObjectBuilder<Suggest>> fn)Add a key/value tosuggest(Map), creating the map if needed.SubmitRequest.Builderquery(Query value)API name:querySubmitRequest.Builderquery(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)API name:querySubmitRequest.BuilderrequestCache(java.lang.Boolean value)API name:request_cacheSubmitRequest.Builderrescore(Rescore... value)API name:rescoreSubmitRequest.Builderrescore(java.util.function.Function<Rescore.Builder,ObjectBuilder<Rescore>> fn)Setrescore(List)to a singleton list.SubmitRequest.Builderrescore(java.util.List<Rescore> value)API name:rescoreSubmitRequest.Builderrouting(java.lang.String value)API name:routingSubmitRequest.BuilderruntimeMappings(java.lang.String key, java.util.function.Function<RuntimeField.Builder,ObjectBuilder<RuntimeField>> fn)SetruntimeMappings(Map)to a singleton map.SubmitRequest.BuilderruntimeMappings(java.util.Map<java.lang.String,RuntimeField> value)API name:runtime_mappingsSubmitRequest.BuilderscriptFields(java.lang.String key, java.util.function.Function<ScriptField.Builder,ObjectBuilder<ScriptField>> fn)SetscriptFields(Map)to a singleton map.SubmitRequest.BuilderscriptFields(java.util.Map<java.lang.String,ScriptField> value)API name:script_fieldsSubmitRequest.BuildersearchAfter(java.lang.String... value)API name:search_afterSubmitRequest.BuildersearchAfter(java.util.List<java.lang.String> value)API name:search_afterSubmitRequest.BuildersearchType(SearchType value)API name:search_typeSubmitRequest.BuildersequenceNumberPrimaryTerm(java.lang.Boolean value)API name:sequence_number_primary_termSubmitRequest.Buildersize(java.lang.Integer value)API name:sizeSubmitRequest.Buildersort(jakarta.json.JsonValue... value)API name:sortSubmitRequest.Buildersort(java.util.List<jakarta.json.JsonValue> value)API name:sortSubmitRequest.Buildersource(jakarta.json.JsonValue value)API name:_sourceSubmitRequest.Builderstats(java.lang.String... value)API name:statsSubmitRequest.Builderstats(java.util.List<java.lang.String> value)API name:statsSubmitRequest.BuilderstoredFields(java.lang.String... value)API name:stored_fieldsSubmitRequest.BuilderstoredFields(java.util.List<java.lang.String> value)API name:stored_fieldsSubmitRequest.Buildersuggest(java.lang.String key, java.util.function.Function<Suggest.Builder,ObjectBuilder<Suggest>> fn)Setsuggest(Map)to a singleton map.SubmitRequest.Buildersuggest(java.util.Map<java.lang.String,Suggest> value)API name:suggestSubmitRequest.BuildersuggestField(java.lang.String value)API name:suggest_fieldSubmitRequest.BuildersuggestMode(SuggestMode value)API name:suggest_modeSubmitRequest.BuildersuggestSize(java.lang.Long value)API name:suggest_sizeSubmitRequest.BuildersuggestText(java.lang.String value)API name:suggest_textSubmitRequest.BuilderterminateAfter(java.lang.Long value)API name:terminate_afterSubmitRequest.Buildertimeout(java.lang.String value)API name:timeoutSubmitRequest.BuildertrackScores(java.lang.Boolean value)API name:track_scoresSubmitRequest.BuildertrackTotalHits(java.lang.Boolean value)API name:track_total_hitsSubmitRequest.BuildertypedKeys(java.lang.Boolean value)Specify whether aggregation and suggester names should be prefixed by their respective types in the responseSubmitRequest.Builderversion(java.lang.Boolean value)API name:versionSubmitRequest.BuilderwaitForCompletionTimeout(java.lang.String value)Specify the time that the request should block waiting for the final responseMethods 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
A comma-separated list of index names to search; use_allor empty string to perform the operation on all indicesAPI name:
index -
index
A comma-separated list of index names to search; use_allor empty string to perform the operation on all indicesAPI name:
index -
addIndex
Add a value toindex(List), creating the list if needed. -
batchedReduceSize
The number of shard results that should be reduced at once on the coordinating node. This value should be used as the granularity at which progress results will be made available.API name:
batched_reduce_size -
waitForCompletionTimeout
Specify the time that the request should block waiting for the final responseAPI name:
wait_for_completion_timeout -
keepOnCompletion
Control whether the response should be stored in the cluster if it completed within the provided [wait_for_completion] time (default: false)API name:
keep_on_completion -
typedKeys
Specify whether aggregation and suggester names should be prefixed by their respective types in the responseAPI name:
typed_keys -
aggs
API name:aggs -
putAggs
Add a key/value toaggs(Map), creating the map if needed. -
aggs
public SubmitRequest.Builder aggs(java.lang.String key, java.util.function.Function<Aggregation.Builder,ObjectBuilder<Aggregation>> fn)Setaggs(Map)to a singleton map. -
putAggs
public SubmitRequest.Builder putAggs(java.lang.String key, java.util.function.Function<Aggregation.Builder,ObjectBuilder<Aggregation>> fn)Add a key/value toaggs(Map), creating the map if needed. -
allowNoIndices
API name:allow_no_indices -
allowPartialSearchResults
API name:allow_partial_search_results -
analyzer
API name:analyzer -
analyzeWildcard
API name:analyze_wildcard -
collapse
API name:collapse -
collapse
public SubmitRequest.Builder collapse(java.util.function.Function<FieldCollapse.Builder,ObjectBuilder<FieldCollapse>> fn)API name:collapse -
defaultOperator
API name:default_operator -
df
API name:df -
docvalueFields
API name:docvalue_fields -
docvalueFields
API name:docvalue_fields -
addDocvalueFields
Add a value todocvalueFields(List), creating the list if needed. -
expandWildcards
public SubmitRequest.Builder expandWildcards(@Nullable java.util.List<ExpandWildcardOptions> value)API name:expand_wildcards -
expandWildcards
API name:expand_wildcards -
addExpandWildcards
Add a value toexpandWildcards(List), creating the list if needed. -
explain
API name:explain -
from
API name:from -
highlight
API name:highlight -
highlight
public SubmitRequest.Builder highlight(java.util.function.Function<Highlight.Builder,ObjectBuilder<Highlight>> fn)API name:highlight -
ignoreThrottled
API name:ignore_throttled -
indicesBoost
public SubmitRequest.Builder indicesBoost(@Nullable java.util.List<java.util.Map<java.lang.String,java.lang.Double>> value)API name:indices_boost -
indicesBoost
public SubmitRequest.Builder indicesBoost(java.util.Map<java.lang.String,java.lang.Double>... value)API name:indices_boost -
addIndicesBoost
public SubmitRequest.Builder addIndicesBoost(java.util.Map<java.lang.String,java.lang.Double> value)Add a value toindicesBoost(List), creating the list if needed. -
keepAlive
API name:keep_alive -
lenient
API name:lenient -
maxConcurrentShardRequests
API name:max_concurrent_shard_requests -
minScore
API name:min_score -
postFilter
API name:post_filter -
postFilter
public SubmitRequest.Builder postFilter(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)API name:post_filter -
preference
API name:preference -
profile
API name:profile -
pit
API name:pit -
pit
public SubmitRequest.Builder pit(java.util.function.Function<PointInTimeReference.Builder,ObjectBuilder<PointInTimeReference>> fn)API name:pit -
query
API name:query -
query
public SubmitRequest.Builder query(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)API name:query -
requestCache
API name:request_cache -
rescore
API name:rescore -
rescore
API name:rescore -
addRescore
Add a value torescore(List), creating the list if needed. -
rescore
public SubmitRequest.Builder rescore(java.util.function.Function<Rescore.Builder,ObjectBuilder<Rescore>> fn)Setrescore(List)to a singleton list. -
addRescore
public SubmitRequest.Builder addRescore(java.util.function.Function<Rescore.Builder,ObjectBuilder<Rescore>> fn)Add a value torescore(List), creating the list if needed. -
routing
API name:routing -
scriptFields
public SubmitRequest.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 SubmitRequest.Builder scriptFields(java.lang.String key, java.util.function.Function<ScriptField.Builder,ObjectBuilder<ScriptField>> fn)SetscriptFields(Map)to a singleton map. -
putScriptFields
public SubmitRequest.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. -
searchType
API name:search_type -
sequenceNumberPrimaryTerm
API name:sequence_number_primary_term -
size
API name:size -
sort
API name:sort -
sort
API name:sort -
addSort
Add a value tosort(List), creating the list if needed. -
source
API name:_source -
stats
API name:stats -
stats
API name:stats -
addStats
Add a value tostats(List), creating the list if needed. -
storedFields
API name:stored_fields -
storedFields
API name:stored_fields -
addStoredFields
Add a value tostoredFields(List), creating the list if needed. -
suggest
API name:suggest -
putSuggest
Add a key/value tosuggest(Map), creating the map if needed. -
suggest
public SubmitRequest.Builder suggest(java.lang.String key, java.util.function.Function<Suggest.Builder,ObjectBuilder<Suggest>> fn)Setsuggest(Map)to a singleton map. -
putSuggest
public SubmitRequest.Builder putSuggest(java.lang.String key, java.util.function.Function<Suggest.Builder,ObjectBuilder<Suggest>> fn)Add a key/value tosuggest(Map), creating the map if needed. -
suggestField
API name:suggest_field -
suggestMode
API name:suggest_mode -
suggestSize
API name:suggest_size -
suggestText
API name:suggest_text -
terminateAfter
API name:terminate_after -
timeout
API name:timeout -
trackScores
API name:track_scores -
trackTotalHits
API name:track_total_hits -
version
API name:version -
fields
API name:fields -
fields
API name:fields -
addFields
Add a value tofields(List), creating the list if needed. -
runtimeMappings
public SubmitRequest.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 SubmitRequest.Builder runtimeMappings(java.lang.String key, java.util.function.Function<RuntimeField.Builder,ObjectBuilder<RuntimeField>> fn)SetruntimeMappings(Map)to a singleton map. -
putRuntimeMappings
public SubmitRequest.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. -
build
Builds aSubmitRequest.- Specified by:
buildin interfaceObjectBuilder<SubmitRequest>- Throws:
java.lang.NullPointerException- if some of the required fields are null.
-