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.Builder
addDocvalueFields(java.lang.String value)
Add a value todocvalueFields(List)
, creating the list if needed.SubmitRequest.Builder
addExpandWildcards(ExpandWildcardOptions value)
Add a value toexpandWildcards(List)
, creating the list if needed.SubmitRequest.Builder
addFields(jakarta.json.JsonValue value)
Add a value tofields(List)
, creating the list if needed.SubmitRequest.Builder
addIndex(java.lang.String value)
Add a value toindex(List)
, creating the list if needed.SubmitRequest.Builder
addIndicesBoost(java.util.Map<java.lang.String,java.lang.Double> value)
Add a value toindicesBoost(List)
, creating the list if needed.SubmitRequest.Builder
addRescore(Rescore value)
Add a value torescore(List)
, creating the list if needed.SubmitRequest.Builder
addRescore(java.util.function.Function<Rescore.Builder,ObjectBuilder<Rescore>> fn)
Add a value torescore(List)
, creating the list if needed.SubmitRequest.Builder
addSearchAfter(java.lang.String value)
Add a value tosearchAfter(List)
, creating the list if needed.SubmitRequest.Builder
addSort(jakarta.json.JsonValue value)
Add a value tosort(List)
, creating the list if needed.SubmitRequest.Builder
addStats(java.lang.String value)
Add a value tostats(List)
, creating the list if needed.SubmitRequest.Builder
addStoredFields(java.lang.String value)
Add a value tostoredFields(List)
, creating the list if needed.SubmitRequest.Builder
aggs(java.lang.String key, java.util.function.Function<Aggregation.Builder,ObjectBuilder<Aggregation>> fn)
Setaggs(Map)
to a singleton map.SubmitRequest.Builder
aggs(java.util.Map<java.lang.String,Aggregation> value)
API name:aggs
SubmitRequest.Builder
allowNoIndices(java.lang.Boolean value)
API name:allow_no_indices
SubmitRequest.Builder
allowPartialSearchResults(java.lang.Boolean value)
API name:allow_partial_search_results
SubmitRequest.Builder
analyzer(java.lang.String value)
API name:analyzer
SubmitRequest.Builder
analyzeWildcard(java.lang.Boolean value)
API name:analyze_wildcard
SubmitRequest.Builder
batchedReduceSize(java.lang.Long value)
The number of shard results that should be reduced at once on the coordinating node.SubmitRequest
build()
Builds aSubmitRequest
.SubmitRequest.Builder
collapse(FieldCollapse value)
API name:collapse
SubmitRequest.Builder
collapse(java.util.function.Function<FieldCollapse.Builder,ObjectBuilder<FieldCollapse>> fn)
API name:collapse
SubmitRequest.Builder
defaultOperator(DefaultOperator value)
API name:default_operator
SubmitRequest.Builder
df(java.lang.String value)
API name:df
SubmitRequest.Builder
docvalueFields(java.lang.String... value)
API name:docvalue_fields
SubmitRequest.Builder
docvalueFields(java.util.List<java.lang.String> value)
API name:docvalue_fields
SubmitRequest.Builder
expandWildcards(ExpandWildcardOptions... value)
API name:expand_wildcards
SubmitRequest.Builder
expandWildcards(java.util.List<ExpandWildcardOptions> value)
API name:expand_wildcards
SubmitRequest.Builder
explain(java.lang.Boolean value)
API name:explain
SubmitRequest.Builder
fields(jakarta.json.JsonValue... value)
API name:fields
SubmitRequest.Builder
fields(java.util.List<jakarta.json.JsonValue> value)
API name:fields
SubmitRequest.Builder
from(java.lang.Integer value)
API name:from
SubmitRequest.Builder
highlight(Highlight value)
API name:highlight
SubmitRequest.Builder
highlight(java.util.function.Function<Highlight.Builder,ObjectBuilder<Highlight>> fn)
API name:highlight
SubmitRequest.Builder
ignoreThrottled(java.lang.Boolean value)
API name:ignore_throttled
SubmitRequest.Builder
ignoreUnavailable(java.lang.Boolean value)
API name:ignore_unavailable
SubmitRequest.Builder
index(java.lang.String... value)
A comma-separated list of index names to search; use_all
or empty string to perform the operation on all indicesSubmitRequest.Builder
index(java.util.List<java.lang.String> value)
A comma-separated list of index names to search; use_all
or empty string to perform the operation on all indicesSubmitRequest.Builder
indicesBoost(java.util.List<java.util.Map<java.lang.String,java.lang.Double>> value)
API name:indices_boost
SubmitRequest.Builder
indicesBoost(java.util.Map<java.lang.String,java.lang.Double>... value)
API name:indices_boost
SubmitRequest.Builder
keepAlive(java.lang.String value)
API name:keep_alive
SubmitRequest.Builder
keepOnCompletion(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.Builder
lenient(java.lang.Boolean value)
API name:lenient
SubmitRequest.Builder
maxConcurrentShardRequests(java.lang.Long value)
API name:max_concurrent_shard_requests
SubmitRequest.Builder
minScore(java.lang.Double value)
API name:min_score
SubmitRequest.Builder
pit(PointInTimeReference value)
API name:pit
SubmitRequest.Builder
pit(java.util.function.Function<PointInTimeReference.Builder,ObjectBuilder<PointInTimeReference>> fn)
API name:pit
SubmitRequest.Builder
postFilter(Query value)
API name:post_filter
SubmitRequest.Builder
postFilter(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)
API name:post_filter
SubmitRequest.Builder
preference(java.lang.String value)
API name:preference
SubmitRequest.Builder
profile(java.lang.Boolean value)
API name:profile
SubmitRequest.Builder
putAggs(java.lang.String key, Aggregation value)
Add a key/value toaggs(Map)
, creating the map if needed.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.SubmitRequest.Builder
putRuntimeMappings(java.lang.String key, RuntimeField value)
Add a key/value toruntimeMappings(Map)
, creating the map if needed.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.SubmitRequest.Builder
putScriptFields(java.lang.String key, ScriptField value)
Add a key/value toscriptFields(Map)
, creating the map if needed.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.SubmitRequest.Builder
putSuggest(java.lang.String key, Suggest value)
Add a key/value tosuggest(Map)
, creating the map if needed.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.SubmitRequest.Builder
query(Query value)
API name:query
SubmitRequest.Builder
query(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)
API name:query
SubmitRequest.Builder
requestCache(java.lang.Boolean value)
API name:request_cache
SubmitRequest.Builder
rescore(Rescore... value)
API name:rescore
SubmitRequest.Builder
rescore(java.util.function.Function<Rescore.Builder,ObjectBuilder<Rescore>> fn)
Setrescore(List)
to a singleton list.SubmitRequest.Builder
rescore(java.util.List<Rescore> value)
API name:rescore
SubmitRequest.Builder
routing(java.lang.String value)
API name:routing
SubmitRequest.Builder
runtimeMappings(java.lang.String key, java.util.function.Function<RuntimeField.Builder,ObjectBuilder<RuntimeField>> fn)
SetruntimeMappings(Map)
to a singleton map.SubmitRequest.Builder
runtimeMappings(java.util.Map<java.lang.String,RuntimeField> value)
API name:runtime_mappings
SubmitRequest.Builder
scriptFields(java.lang.String key, java.util.function.Function<ScriptField.Builder,ObjectBuilder<ScriptField>> fn)
SetscriptFields(Map)
to a singleton map.SubmitRequest.Builder
scriptFields(java.util.Map<java.lang.String,ScriptField> value)
API name:script_fields
SubmitRequest.Builder
searchAfter(java.lang.String... value)
API name:search_after
SubmitRequest.Builder
searchAfter(java.util.List<java.lang.String> value)
API name:search_after
SubmitRequest.Builder
searchType(SearchType value)
API name:search_type
SubmitRequest.Builder
sequenceNumberPrimaryTerm(java.lang.Boolean value)
API name:sequence_number_primary_term
SubmitRequest.Builder
size(java.lang.Integer value)
API name:size
SubmitRequest.Builder
sort(jakarta.json.JsonValue... value)
API name:sort
SubmitRequest.Builder
sort(java.util.List<jakarta.json.JsonValue> value)
API name:sort
SubmitRequest.Builder
source(jakarta.json.JsonValue value)
API name:_source
SubmitRequest.Builder
stats(java.lang.String... value)
API name:stats
SubmitRequest.Builder
stats(java.util.List<java.lang.String> value)
API name:stats
SubmitRequest.Builder
storedFields(java.lang.String... value)
API name:stored_fields
SubmitRequest.Builder
storedFields(java.util.List<java.lang.String> value)
API name:stored_fields
SubmitRequest.Builder
suggest(java.lang.String key, java.util.function.Function<Suggest.Builder,ObjectBuilder<Suggest>> fn)
Setsuggest(Map)
to a singleton map.SubmitRequest.Builder
suggest(java.util.Map<java.lang.String,Suggest> value)
API name:suggest
SubmitRequest.Builder
suggestField(java.lang.String value)
API name:suggest_field
SubmitRequest.Builder
suggestMode(SuggestMode value)
API name:suggest_mode
SubmitRequest.Builder
suggestSize(java.lang.Long value)
API name:suggest_size
SubmitRequest.Builder
suggestText(java.lang.String value)
API name:suggest_text
SubmitRequest.Builder
terminateAfter(java.lang.Long value)
API name:terminate_after
SubmitRequest.Builder
timeout(java.lang.String value)
API name:timeout
SubmitRequest.Builder
trackScores(java.lang.Boolean value)
API name:track_scores
SubmitRequest.Builder
trackTotalHits(java.lang.Boolean value)
API name:track_total_hits
SubmitRequest.Builder
typedKeys(java.lang.Boolean value)
Specify whether aggregation and suggester names should be prefixed by their respective types in the responseSubmitRequest.Builder
version(java.lang.Boolean value)
API name:version
SubmitRequest.Builder
waitForCompletionTimeout(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_all
or empty string to perform the operation on all indicesAPI name:
index
-
index
A comma-separated list of index names to search; use_all
or 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:
build
in interfaceObjectBuilder<SubmitRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-