Class FleetSearchRequest.Builder
- All Implemented Interfaces:
WithJson<FleetSearchRequest.Builder>
,ObjectBuilder<FleetSearchRequest>
- Enclosing class:
- FleetSearchRequest
FleetSearchRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaggregations
(String key, Aggregation value) API name:aggregations
API name:aggregations
aggregations
(Map<String, Aggregation> map) API name:aggregations
allowNoIndices
(Boolean value) API name:allow_no_indices
allowPartialSearchResults
(Boolean value) If true, returns partial results if there are shard request timeouts or shard failures.API name:analyzer
analyzeWildcard
(Boolean value) API name:analyze_wildcard
batchedReduceSize
(Long value) API name:batched_reduce_size
build()
Builds aFleetSearchRequest
.ccsMinimizeRoundtrips
(Boolean value) API name:ccs_minimize_roundtrips
collapse
(FieldCollapse value) API name:collapse
API name:collapse
defaultOperator
(Operator value) API name:default_operator
API name:df
docvalueFields
(FieldAndFormat value, FieldAndFormat... values) Array of wildcard (*) patterns.Array of wildcard (*) patterns.docvalueFields
(List<FieldAndFormat> list) Array of wildcard (*) patterns.expandWildcards
(ExpandWildcard value, ExpandWildcard... values) API name:expand_wildcards
expandWildcards
(List<ExpandWildcard> list) API name:expand_wildcards
If true, returns detailed information about score computation as part of a hit.Configuration of search extensions defined by Elasticsearch plugins.Configuration of search extensions defined by Elasticsearch plugins.fields
(FieldAndFormat value, FieldAndFormat... values) Array of wildcard (*) patterns.Array of wildcard (*) patterns.fields
(List<FieldAndFormat> list) Array of wildcard (*) patterns.Starting document offset.API name:highlight
API name:highlight
ignoreThrottled
(Boolean value) API name:ignore_throttled
ignoreUnavailable
(Boolean value) API name:ignore_unavailable
Required - A single target to search.indicesBoost
(List<Map<String, Double>> list) Boosts the _score of documents from specified indices.Boosts the _score of documents from specified indices.API name:lenient
maxConcurrentShardRequests
(Long value) API name:max_concurrent_shard_requests
minCompatibleShardNode
(String value) API name:min_compatible_shard_node
Minimum _score for matching documents.pit
(PointInTimeReference value) Limits the search to a point in time (PIT).Limits the search to a point in time (PIT).postFilter
(Query value) API name:post_filter
API name:post_filter
preference
(String value) API name:preference
preFilterShardSize
(Long value) API name:pre_filter_shard_size
API name:profile
API name:q
Defines the search definition using the Query DSL.Defines the search definition using the Query DSL.requestCache
(Boolean value) API name:request_cache
API name:rescore
API name:rescore
API name:rescore
API name:routing
runtimeMappings
(String key, RuntimeField value) Defines one or more runtime fields in the search request.Defines one or more runtime fields in the search request.runtimeMappings
(Map<String, RuntimeField> map) Defines one or more runtime fields in the search request.scriptFields
(String key, ScriptField value) Retrieve a script evaluation (based on different fields) for each hit.Retrieve a script evaluation (based on different fields) for each hit.scriptFields
(Map<String, ScriptField> map) Retrieve a script evaluation (based on different fields) for each hit.API name:scroll
API name:scroll
searchAfter
(FieldValue value, FieldValue... values) API name:search_after
API name:search_after
searchAfter
(List<FieldValue> list) API name:search_after
searchType
(SearchType value) API name:search_type
protected FleetSearchRequest.Builder
self()
seqNoPrimaryTerm
(Boolean value) If true, returns sequence number and primary term of the last modification of each hit.The number of hits to return.slice
(SlicedScroll value) API name:slice
API name:slice
sort
(SortOptions value, SortOptions... values) API name:sort
API name:sort
sort
(List<SortOptions> list) API name:sort
source
(SourceConfig value) Indicates which source fields are returned for matching documents.Indicates which source fields are returned for matching documents.Stats groups to associate with the search.Stats groups to associate with the search.storedFields
(String value, String... values) List of stored fields to return as part of a hit.storedFields
(List<String> list) List of stored fields to return as part of a hit.API name:suggest
API name:suggest
terminateAfter
(Long value) Maximum number of documents to collect for each shard.Specifies the period of time to wait for a response from each shard.trackScores
(Boolean value) If true, calculate and return document scores, even if the scores are not used for sorting.trackTotalHits
(TrackHits value) Number of hits matching the query to count accurately.Number of hits matching the query to count accurately.If true, returns document version as part of a hit.waitForCheckpoints
(Long value, Long... values) A comma separated list of checkpoints.waitForCheckpoints
(List<Long> list) A comma separated list of checkpoints.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 FleetSearchRequest.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 FleetSearchRequest.Builder aggregations(String key, Function<Aggregation.Builder, ObjectBuilder<Aggregation>> fn) API name:aggregations
Adds an entry to
aggregations
using a builder lambda. -
allowNoIndices
API name:allow_no_indices
-
allowPartialSearchResults
If true, returns partial results if there are shard request timeouts or shard failures. If false, returns an error with no partial results. Defaults to the configured cluster settingsearch.default_allow_partial_results
which is true by default.API name:
allow_partial_search_results
-
analyzeWildcard
API name:analyze_wildcard
-
analyzer
API name:analyzer
-
batchedReduceSize
API name:batched_reduce_size
-
ccsMinimizeRoundtrips
API name:ccs_minimize_roundtrips
-
collapse
API name:collapse
-
collapse
public final FleetSearchRequest.Builder collapse(Function<FieldCollapse.Builder, ObjectBuilder<FieldCollapse>> fn) API name:collapse
-
defaultOperator
API name:default_operator
-
df
API 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
public final FleetSearchRequest.Builder docvalueFields(FieldAndFormat value, FieldAndFormat... values) 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 FleetSearchRequest.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
API name:expand_wildcards
Adds all elements of
list
toexpandWildcards
. -
expandWildcards
public final FleetSearchRequest.Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values) 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 FleetSearchRequest.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 FleetSearchRequest.Builder highlight(Function<Highlight.Builder, ObjectBuilder<Highlight>> fn) API name:highlight
-
ignoreThrottled
API name:ignore_throttled
-
index
Required - A single target to search. If the target is an index alias, it must resolve to a single index.API name:
index
-
indicesBoost
Boosts the _score of documents from specified indices.API name:
indices_boost
Adds all elements of
list
toindicesBoost
. -
indicesBoost
public final FleetSearchRequest.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
. -
lenient
API name:lenient
-
maxConcurrentShardRequests
API 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 FleetSearchRequest.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
API name:pre_filter_shard_size
-
preference
API name:preference
-
profile
API name:profile
-
q
API 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
API 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
public final FleetSearchRequest.Builder rescore(Function<Rescore.Builder, ObjectBuilder<Rescore>> fn) API name:rescore
Adds a value to
rescore
using a builder lambda. -
routing
API 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 FleetSearchRequest.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 FleetSearchRequest.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 FleetSearchRequest.Builder searchAfter(Function<FieldValue.Builder, ObjectBuilder<FieldValue>> fn) API name:search_after
Adds a value to
searchAfter
using a builder lambda. -
searchType
API 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 FleetSearchRequest.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 FleetSearchRequest.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
public final FleetSearchRequest.Builder suggest(Function<Suggester.Builder, ObjectBuilder<Suggester>> fn) 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 FleetSearchRequest.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
-
waitForCheckpoints
A comma separated list of checkpoints. When configured, the search API will only be executed on a shard after the relevant checkpoint has become visible for search. Defaults to an empty list which will cause Elasticsearch to immediately execute the search.API name:
wait_for_checkpoints
Adds all elements of
list
towaitForCheckpoints
. -
waitForCheckpoints
A comma separated list of checkpoints. When configured, the search API will only be executed on a shard after the relevant checkpoint has become visible for search. Defaults to an empty list which will cause Elasticsearch to immediately execute the search.API name:
wait_for_checkpoints
Adds one or more values to
waitForCheckpoints
. -
self
- Specified by:
self
in classRequestBase.AbstractBuilder<FleetSearchRequest.Builder>
-
build
Builds aFleetSearchRequest
.- Specified by:
build
in interfaceObjectBuilder<FleetSearchRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-