Class SubmitRequest.Builder
- All Implemented Interfaces:
WithJson<SubmitRequest.Builder>
,ObjectBuilder<SubmitRequest>
- Enclosing class:
- SubmitRequest
SubmitRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal SubmitRequest.Builder
aggregations
(String key, Aggregation value) API name:aggregations
final SubmitRequest.Builder
API name:aggregations
final SubmitRequest.Builder
aggregations
(Map<String, Aggregation> map) API name:aggregations
final SubmitRequest.Builder
allowNoIndices
(Boolean value) Whether to ignore if a wildcard indices expression resolves into no concrete indices.final SubmitRequest.Builder
allowPartialSearchResults
(Boolean value) Indicate if an error should be returned if there is a partial search failure or timeoutfinal SubmitRequest.Builder
The analyzer to use for the query stringfinal SubmitRequest.Builder
analyzeWildcard
(Boolean value) Specify whether wildcard and prefix queries should be analyzed (default: false)final SubmitRequest.Builder
batchedReduceSize
(Long value) Affects how often partial results become available, which happens whenever shard results are reduced.build()
Builds aSubmitRequest
.final SubmitRequest.Builder
ccsMinimizeRoundtrips
(Boolean value) The default value is the only supported value.final SubmitRequest.Builder
collapse
(FieldCollapse value) API name:collapse
final SubmitRequest.Builder
API name:collapse
final SubmitRequest.Builder
defaultOperator
(Operator value) The default operator for query string query (AND or OR)final SubmitRequest.Builder
The field to use as default where no field prefix is given in the query stringfinal SubmitRequest.Builder
docvalueFields
(FieldAndFormat value, FieldAndFormat... values) Array of wildcard (*) patterns.final SubmitRequest.Builder
Array of wildcard (*) patterns.final SubmitRequest.Builder
docvalueFields
(List<FieldAndFormat> list) Array of wildcard (*) patterns.final SubmitRequest.Builder
expandWildcards
(ExpandWildcard value, ExpandWildcard... values) Whether to expand wildcard expression to concrete indices that are open, closed or both.final SubmitRequest.Builder
expandWildcards
(List<ExpandWildcard> list) Whether to expand wildcard expression to concrete indices that are open, closed or both.final SubmitRequest.Builder
If true, returns detailed information about score computation as part of a hit.final SubmitRequest.Builder
Configuration of search extensions defined by Elasticsearch plugins.final SubmitRequest.Builder
Configuration of search extensions defined by Elasticsearch plugins.final SubmitRequest.Builder
fields
(FieldAndFormat value, FieldAndFormat... values) Array of wildcard (*) patterns.final SubmitRequest.Builder
Array of wildcard (*) patterns.final SubmitRequest.Builder
fields
(List<FieldAndFormat> list) Array of wildcard (*) patterns.final SubmitRequest.Builder
Starting document offset.final SubmitRequest.Builder
API name:highlight
final SubmitRequest.Builder
API name:highlight
final SubmitRequest.Builder
ignoreThrottled
(Boolean value) Whether specified concrete, expanded or aliased indices should be ignored when throttledfinal SubmitRequest.Builder
ignoreUnavailable
(Boolean value) Whether specified concrete indices should be ignored when unavailable (missing or closed)final SubmitRequest.Builder
A comma-separated list of index names to search; use_all
or empty string to perform the operation on all indicesfinal SubmitRequest.Builder
A comma-separated list of index names to search; use_all
or empty string to perform the operation on all indicesfinal SubmitRequest.Builder
indicesBoost
(List<Map<String, Double>> list) Boosts the _score of documents from specified indices.final SubmitRequest.Builder
Boosts the _score of documents from specified indices.final SubmitRequest.Builder
Specifies how long the async search needs to be available.final SubmitRequest.Builder
Specifies how long the async search needs to be available.final SubmitRequest.Builder
keepOnCompletion
(Boolean value) Iftrue
, results are stored for later retrieval when the search completes within thewait_for_completion_timeout
.final SubmitRequest.Builder
Defines the approximate kNN search to run.final SubmitRequest.Builder
Defines the approximate kNN search to run.final SubmitRequest.Builder
Defines the approximate kNN search to run.final SubmitRequest.Builder
Specify whether format-based query failures (such as providing text to a numeric field) should be ignoredfinal SubmitRequest.Builder
maxConcurrentShardRequests
(Long value) The number of concurrent shard requests per node this search executes concurrently.final SubmitRequest.Builder
minCompatibleShardNode
(String value) API name:min_compatible_shard_node
final SubmitRequest.Builder
Minimum _score for matching documents.final SubmitRequest.Builder
pit
(PointInTimeReference value) Limits the search to a point in time (PIT).final SubmitRequest.Builder
Limits the search to a point in time (PIT).final SubmitRequest.Builder
postFilter
(Query value) API name:post_filter
final SubmitRequest.Builder
API name:post_filter
final SubmitRequest.Builder
preference
(String value) Specify the node or shard the operation should be performed on (default: random)final SubmitRequest.Builder
preFilterShardSize
(Long value) The default value cannot be changed, which enforces the execution of a pre-filter roundtrip to retrieve statistics from each shard so that the ones that surely don’t hold any document matching the query get skipped.final SubmitRequest.Builder
API name:profile
final SubmitRequest.Builder
Query in the Lucene query string syntaxfinal SubmitRequest.Builder
Defines the search definition using the Query DSL.final SubmitRequest.Builder
Defines the search definition using the Query DSL.final SubmitRequest.Builder
requestCache
(Boolean value) Specify if request cache should be used for this request or not, defaults to truefinal SubmitRequest.Builder
API name:rescore
final SubmitRequest.Builder
API name:rescore
final SubmitRequest.Builder
API name:rescore
final SubmitRequest.Builder
A comma-separated list of specific routing valuesfinal SubmitRequest.Builder
runtimeMappings
(String key, RuntimeField value) Defines one or more runtime fields in the search request.final SubmitRequest.Builder
Defines one or more runtime fields in the search request.final SubmitRequest.Builder
runtimeMappings
(Map<String, RuntimeField> map) Defines one or more runtime fields in the search request.final SubmitRequest.Builder
scriptFields
(String key, ScriptField value) Retrieve a script evaluation (based on different fields) for each hit.final SubmitRequest.Builder
Retrieve a script evaluation (based on different fields) for each hit.final SubmitRequest.Builder
scriptFields
(Map<String, ScriptField> map) Retrieve a script evaluation (based on different fields) for each hit.final SubmitRequest.Builder
API name:scroll
final SubmitRequest.Builder
API name:scroll
final SubmitRequest.Builder
searchAfter
(FieldValue value, FieldValue... values) API name:search_after
final SubmitRequest.Builder
API name:search_after
final SubmitRequest.Builder
searchAfter
(List<FieldValue> list) API name:search_after
final SubmitRequest.Builder
searchType
(SearchType value) Search operation typeprotected SubmitRequest.Builder
self()
final SubmitRequest.Builder
seqNoPrimaryTerm
(Boolean value) If true, returns sequence number and primary term of the last modification of each hit.final SubmitRequest.Builder
The number of hits to return.final SubmitRequest.Builder
slice
(SlicedScroll value) API name:slice
final SubmitRequest.Builder
API name:slice
final SubmitRequest.Builder
sort
(SortOptions value, SortOptions... values) API name:sort
final SubmitRequest.Builder
API name:sort
final SubmitRequest.Builder
sort
(List<SortOptions> list) API name:sort
final SubmitRequest.Builder
source
(SourceConfig value) Indicates which source fields are returned for matching documents.final SubmitRequest.Builder
Indicates which source fields are returned for matching documents.final SubmitRequest.Builder
Stats groups to associate with the search.final SubmitRequest.Builder
Stats groups to associate with the search.final SubmitRequest.Builder
storedFields
(String value, String... values) List of stored fields to return as part of a hit.final SubmitRequest.Builder
storedFields
(List<String> list) List of stored fields to return as part of a hit.final SubmitRequest.Builder
API name:suggest
final SubmitRequest.Builder
API name:suggest
final SubmitRequest.Builder
terminateAfter
(Long value) Maximum number of documents to collect for each shard.final SubmitRequest.Builder
Specifies the period of time to wait for a response from each shard.final SubmitRequest.Builder
trackScores
(Boolean value) If true, calculate and return document scores, even if the scores are not used for sorting.final SubmitRequest.Builder
trackTotalHits
(TrackHits value) Number of hits matching the query to count accurately.final SubmitRequest.Builder
Number of hits matching the query to count accurately.final SubmitRequest.Builder
If true, returns document version as part of a hit.final SubmitRequest.Builder
waitForCompletionTimeout
(Time value) Blocks and waits until the search is completed up to a certain timeout.final SubmitRequest.Builder
Blocks and waits until the search is completed up to a certain timeout.Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
source
Indicates which source fields are returned for matching documents. These fields are returned in the hits._source property of the search response.API name:
_source
-
source
public final SubmitRequest.Builder source(Function<SourceConfig.Builder, ObjectBuilder<SourceConfig>> fn) Indicates which source fields are returned for matching documents. These fields are returned in the hits._source property of the search response.API name:
_source
-
aggregations
API name:aggregations
Adds all entries of
map
toaggregations
. -
aggregations
API name:aggregations
Adds an entry to
aggregations
. -
aggregations
public final SubmitRequest.Builder aggregations(String key, Function<Aggregation.Builder, ObjectBuilder<Aggregation>> fn) API name:aggregations
Adds an entry to
aggregations
using a builder lambda. -
allowNoIndices
Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes_all
string or when no indices have been specified)API name:
allow_no_indices
-
allowPartialSearchResults
Indicate if an error should be returned if there is a partial search failure or timeoutAPI name:
allow_partial_search_results
-
analyzeWildcard
Specify whether wildcard and prefix queries should be analyzed (default: false)API name:
analyze_wildcard
-
analyzer
The analyzer to use for the query stringAPI name:
analyzer
-
batchedReduceSize
Affects how often partial results become available, which happens whenever shard results are reduced. A partial reduction is performed every time the coordinating node has received a certain number of new shard responses (5 by default).API name:
batched_reduce_size
-
ccsMinimizeRoundtrips
The default value is the only supported value.API name:
ccs_minimize_roundtrips
-
collapse
API name:collapse
-
collapse
public final SubmitRequest.Builder collapse(Function<FieldCollapse.Builder, ObjectBuilder<FieldCollapse>> fn) API name:collapse
-
defaultOperator
The default operator for query string query (AND or OR)API name:
default_operator
-
df
The field to use as default where no field prefix is given in the query stringAPI name:
df
-
docvalueFields
Array of wildcard (*) patterns. The request returns doc values for field names matching these patterns in the hits.fields property of the response.API name:
docvalue_fields
Adds all elements of
list
todocvalueFields
. -
docvalueFields
Array of wildcard (*) patterns. The request returns doc values for field names matching these patterns in the hits.fields property of the response.API name:
docvalue_fields
Adds one or more values to
docvalueFields
. -
docvalueFields
public final SubmitRequest.Builder docvalueFields(Function<FieldAndFormat.Builder, ObjectBuilder<FieldAndFormat>> fn) Array of wildcard (*) patterns. The request returns doc values for field names matching these patterns in the hits.fields property of the response.API name:
docvalue_fields
Adds a value to
docvalueFields
using a builder lambda. -
expandWildcards
Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
Adds all elements of
list
toexpandWildcards
. -
expandWildcards
Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
Adds one or more values to
expandWildcards
. -
explain
If true, returns detailed information about score computation as part of a hit.API name:
explain
-
ext
Configuration of search extensions defined by Elasticsearch plugins.API name:
ext
Adds all entries of
map
toext
. -
ext
Configuration of search extensions defined by Elasticsearch plugins.API name:
ext
Adds an entry to
ext
. -
fields
Array of wildcard (*) patterns. The request returns values for field names matching these patterns in the hits.fields property of the response.API name:
fields
Adds all elements of
list
tofields
. -
fields
Array of wildcard (*) patterns. The request returns values for field names matching these patterns in the hits.fields property of the response.API name:
fields
Adds one or more values to
fields
. -
fields
public final SubmitRequest.Builder fields(Function<FieldAndFormat.Builder, ObjectBuilder<FieldAndFormat>> fn) Array of wildcard (*) patterns. The request returns values for field names matching these patterns in the hits.fields property of the response.API name:
fields
Adds a value to
fields
using a builder lambda. -
from
Starting document offset. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter.API name:
from
-
highlight
API name:highlight
-
highlight
public final SubmitRequest.Builder highlight(Function<Highlight.Builder, ObjectBuilder<Highlight>> fn) API name:highlight
-
ignoreThrottled
Whether specified concrete, expanded or aliased indices should be ignored when throttledAPI name:
ignore_throttled
-
index
A comma-separated list of index names to search; use_all
or empty string to perform the operation on all indicesAPI name:
index
Adds all elements of
list
toindex
. -
index
A comma-separated list of index names to search; use_all
or empty string to perform the operation on all indicesAPI name:
index
Adds one or more values to
index
. -
indicesBoost
Boosts the _score of documents from specified indices.API name:
indices_boost
Adds all elements of
list
toindicesBoost
. -
indicesBoost
public final SubmitRequest.Builder indicesBoost(Map<String, Double> value, Map<String, Double>... values) Boosts the _score of documents from specified indices.API name:
indices_boost
Adds one or more values to
indicesBoost
. -
keepAlive
Specifies how long the async search needs to be available. Ongoing async searches and any saved search results are deleted after this period.API name:
keep_alive
-
keepAlive
Specifies how long the async search needs to be available. Ongoing async searches and any saved search results are deleted after this period.API name:
keep_alive
-
keepOnCompletion
Iftrue
, results are stored for later retrieval when the search completes within thewait_for_completion_timeout
.API name:
keep_on_completion
-
knn
Defines the approximate kNN search to run.API name:
knn
Adds all elements of
list
toknn
. -
knn
Defines the approximate kNN search to run.API name:
knn
Adds one or more values to
knn
. -
knn
Defines the approximate kNN search to run.API name:
knn
Adds a value to
knn
using a builder lambda. -
lenient
Specify whether format-based query failures (such as providing text to a numeric field) should be ignoredAPI name:
lenient
-
maxConcurrentShardRequests
The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requestsAPI name:
max_concurrent_shard_requests
-
minCompatibleShardNode
API name:min_compatible_shard_node
-
minScore
Minimum _score for matching documents. Documents with a lower _score are not included in the search results.API name:
min_score
-
pit
Limits the search to a point in time (PIT). If you provide a PIT, you cannot specify an <index> in the request path.API name:
pit
-
pit
public final SubmitRequest.Builder pit(Function<PointInTimeReference.Builder, ObjectBuilder<PointInTimeReference>> fn) Limits the search to a point in time (PIT). If you provide a PIT, you cannot specify an <index> in the request path.API name:
pit
-
postFilter
API name:post_filter
-
postFilter
API name:post_filter
-
preFilterShardSize
The default value cannot be changed, which enforces the execution of a pre-filter roundtrip to retrieve statistics from each shard so that the ones that surely don’t hold any document matching the query get skipped.API name:
pre_filter_shard_size
-
preference
Specify the node or shard the operation should be performed on (default: random)API name:
preference
-
profile
API name:profile
-
q
Query in the Lucene query string syntaxAPI name:
q
-
query
Defines the search definition using the Query DSL.API name:
query
-
query
Defines the search definition using the Query DSL.API name:
query
-
requestCache
Specify if request cache should be used for this request or not, defaults to trueAPI name:
request_cache
-
rescore
API name:rescore
Adds all elements of
list
torescore
. -
rescore
API name:rescore
Adds one or more values to
rescore
. -
rescore
API name:rescore
Adds a value to
rescore
using a builder lambda. -
routing
A comma-separated list of specific routing valuesAPI name:
routing
-
runtimeMappings
Defines one or more runtime fields in the search request. These fields take precedence over mapped fields with the same name.API name:
runtime_mappings
Adds all entries of
map
toruntimeMappings
. -
runtimeMappings
Defines one or more runtime fields in the search request. These fields take precedence over mapped fields with the same name.API name:
runtime_mappings
Adds an entry to
runtimeMappings
. -
runtimeMappings
public final SubmitRequest.Builder runtimeMappings(String key, Function<RuntimeField.Builder, ObjectBuilder<RuntimeField>> fn) Defines one or more runtime fields in the search request. These fields take precedence over mapped fields with the same name.API name:
runtime_mappings
Adds an entry to
runtimeMappings
using a builder lambda. -
scriptFields
Retrieve a script evaluation (based on different fields) for each hit.API name:
script_fields
Adds all entries of
map
toscriptFields
. -
scriptFields
Retrieve a script evaluation (based on different fields) for each hit.API name:
script_fields
Adds an entry to
scriptFields
. -
scriptFields
public final SubmitRequest.Builder scriptFields(String key, Function<ScriptField.Builder, ObjectBuilder<ScriptField>> fn) Retrieve a script evaluation (based on different fields) for each hit.API name:
script_fields
Adds an entry to
scriptFields
using a builder lambda. -
scroll
API name:scroll
-
scroll
API name:scroll
-
searchAfter
API name:search_after
Adds all elements of
list
tosearchAfter
. -
searchAfter
API name:search_after
Adds one or more values to
searchAfter
. -
searchAfter
public final SubmitRequest.Builder searchAfter(Function<FieldValue.Builder, ObjectBuilder<FieldValue>> fn) API name:search_after
Adds a value to
searchAfter
using a builder lambda. -
searchType
Search operation typeAPI name:
search_type
-
seqNoPrimaryTerm
If true, returns sequence number and primary term of the last modification of each hit. See Optimistic concurrency control.API name:
seq_no_primary_term
-
size
The number of hits to return. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter.API name:
size
-
slice
API name:slice
-
slice
public final SubmitRequest.Builder slice(Function<SlicedScroll.Builder, ObjectBuilder<SlicedScroll>> fn) API name:slice
-
sort
API name:sort
Adds all elements of
list
tosort
. -
sort
API name:sort
Adds one or more values to
sort
. -
sort
public final SubmitRequest.Builder sort(Function<SortOptions.Builder, ObjectBuilder<SortOptions>> fn) API name:sort
Adds a value to
sort
using a builder lambda. -
stats
Stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. You can retrieve these stats using the indices stats API.API name:
stats
Adds all elements of
list
tostats
. -
stats
Stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. You can retrieve these stats using the indices stats API.API name:
stats
Adds one or more values to
stats
. -
storedFields
List of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the _source parameter defaults to false. You can pass _source: true to return both source fields and stored fields in the search response.API name:
stored_fields
Adds all elements of
list
tostoredFields
. -
storedFields
List of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the _source parameter defaults to false. You can pass _source: true to return both source fields and stored fields in the search response.API name:
stored_fields
Adds one or more values to
storedFields
. -
suggest
API name:suggest
-
suggest
API name:suggest
-
terminateAfter
Maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting. Defaults to 0, which does not terminate query execution early.API name:
terminate_after
-
timeout
Specifies the period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout.API name:
timeout
-
trackScores
If true, calculate and return document scores, even if the scores are not used for sorting.API name:
track_scores
-
trackTotalHits
Number of hits matching the query to count accurately. If true, the exact number of hits is returned at the cost of some performance. If false, the response does not include the total number of hits matching the query. Defaults to 10,000 hits.API name:
track_total_hits
-
trackTotalHits
public final SubmitRequest.Builder trackTotalHits(Function<TrackHits.Builder, ObjectBuilder<TrackHits>> fn) Number of hits matching the query to count accurately. If true, the exact number of hits is returned at the cost of some performance. If false, the response does not include the total number of hits matching the query. Defaults to 10,000 hits.API name:
track_total_hits
-
version
If true, returns document version as part of a hit.API name:
version
-
waitForCompletionTimeout
Blocks and waits until the search is completed up to a certain timeout. When the async search completes within the timeout, the response won’t include the ID as the results are not stored in the cluster.API name:
wait_for_completion_timeout
-
waitForCompletionTimeout
public final SubmitRequest.Builder waitForCompletionTimeout(Function<Time.Builder, ObjectBuilder<Time>> fn) Blocks and waits until the search is completed up to a certain timeout. When the async search completes within the timeout, the response won’t include the ID as the results are not stored in the cluster.API name:
wait_for_completion_timeout
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<SubmitRequest.Builder>
-
build
Builds aSubmitRequest
.- Specified by:
build
in interfaceObjectBuilder<SubmitRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-