Package co.elastic.clients.elasticsearch.fleet

Class FleetSearchRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<FleetSearchRequest.Builder>

co.elastic.clients.elasticsearch.fleet.FleetSearchRequest.Builder

All Implemented Interfaces:

WithJson<FleetSearchRequest.Builder>, ObjectBuilder<FleetSearchRequest>

Enclosing class:

FleetSearchRequest

public static class FleetSearchRequest.Builder
extends RequestBase.AbstractBuilder<FleetSearchRequest.Builder>
implements ObjectBuilder<FleetSearchRequest>

Builder for FleetSearchRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final FleetSearchRequest.Builder	aggregations(String key, Aggregation value)	API name: aggregations
final FleetSearchRequest.Builder	aggregations(String key, AggregationVariant value)	API name: aggregations
final FleetSearchRequest.Builder	aggregations(String key, Function<Aggregation.Builder,ObjectBuilder<Aggregation>> fn)	API name: aggregations
final FleetSearchRequest.Builder	aggregations(Map<String,Aggregation> map)	API name: aggregations
final FleetSearchRequest.Builder	allowNoIndices(Boolean value)	API name: allow_no_indices
final FleetSearchRequest.Builder	allowPartialSearchResults(Boolean value)	If true, returns partial results if there are shard request timeouts or shard failures.
final FleetSearchRequest.Builder	analyzer(String value)	API name: analyzer
final FleetSearchRequest.Builder	analyzeWildcard(Boolean value)	API name: analyze_wildcard
final FleetSearchRequest.Builder	batchedReduceSize(Long value)	API name: batched_reduce_size
FleetSearchRequest	build()	Builds a FleetSearchRequest.
final FleetSearchRequest.Builder	ccsMinimizeRoundtrips(Boolean value)	API name: ccs_minimize_roundtrips
final FleetSearchRequest.Builder	collapse(FieldCollapse value)	API name: collapse
final FleetSearchRequest.Builder	collapse(Function<FieldCollapse.Builder,ObjectBuilder<FieldCollapse>> fn)	API name: collapse
final FleetSearchRequest.Builder	defaultOperator(Operator value)	API name: default_operator
final FleetSearchRequest.Builder	df(String value)	API name: df
final FleetSearchRequest.Builder	docvalueFields(FieldAndFormat value, FieldAndFormat... values)	Array of wildcard (*) patterns.
final FleetSearchRequest.Builder	docvalueFields(Function<FieldAndFormat.Builder,ObjectBuilder<FieldAndFormat>> fn)	Array of wildcard (*) patterns.
final FleetSearchRequest.Builder	docvalueFields(List<FieldAndFormat> list)	Array of wildcard (*) patterns.
final FleetSearchRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	API name: expand_wildcards
final FleetSearchRequest.Builder	expandWildcards(List<ExpandWildcard> list)	API name: expand_wildcards
final FleetSearchRequest.Builder	explain(Boolean value)	If true, returns detailed information about score computation as part of a hit.
final FleetSearchRequest.Builder	ext(String key, JsonData value)	Configuration of search extensions defined by Elasticsearch plugins.
final FleetSearchRequest.Builder	ext(Map<String,JsonData> map)	Configuration of search extensions defined by Elasticsearch plugins.
final FleetSearchRequest.Builder	fields(FieldAndFormat value, FieldAndFormat... values)	Array of wildcard (*) patterns.
final FleetSearchRequest.Builder	fields(Function<FieldAndFormat.Builder,ObjectBuilder<FieldAndFormat>> fn)	Array of wildcard (*) patterns.
final FleetSearchRequest.Builder	fields(List<FieldAndFormat> list)	Array of wildcard (*) patterns.
final FleetSearchRequest.Builder	from(Integer value)	Starting document offset.
final FleetSearchRequest.Builder	highlight(Highlight value)	API name: highlight
final FleetSearchRequest.Builder	highlight(Function<Highlight.Builder,ObjectBuilder<Highlight>> fn)	API name: highlight
final FleetSearchRequest.Builder	ignoreThrottled(Boolean value)	API name: ignore_throttled
final FleetSearchRequest.Builder	ignoreUnavailable(Boolean value)	API name: ignore_unavailable
final FleetSearchRequest.Builder	index(String value)	Required - A single target to search.
final FleetSearchRequest.Builder	indicesBoost(NamedValue<Double> value, NamedValue<Double>... values)	Boosts the _score of documents from specified indices.
final FleetSearchRequest.Builder	indicesBoost(List<NamedValue<Double>> list)	Boosts the _score of documents from specified indices.
final FleetSearchRequest.Builder	lenient(Boolean value)	API name: lenient
final FleetSearchRequest.Builder	maxConcurrentShardRequests(Integer value)	API name: max_concurrent_shard_requests
final FleetSearchRequest.Builder	minScore(Double value)	Minimum _score for matching documents.
final FleetSearchRequest.Builder	pit(PointInTimeReference value)	Limits the search to a point in time (PIT).
final FleetSearchRequest.Builder	pit(Function<PointInTimeReference.Builder,ObjectBuilder<PointInTimeReference>> fn)	Limits the search to a point in time (PIT).
final FleetSearchRequest.Builder	postFilter(Query value)	API name: post_filter
final FleetSearchRequest.Builder	postFilter(QueryVariant value)	API name: post_filter
final FleetSearchRequest.Builder	postFilter(Function<Query.Builder,ObjectBuilder<Query>> fn)	API name: post_filter
final FleetSearchRequest.Builder	preference(String value)	API name: preference
final FleetSearchRequest.Builder	preFilterShardSize(Long value)	API name: pre_filter_shard_size
final FleetSearchRequest.Builder	profile(Boolean value)	API name: profile
final FleetSearchRequest.Builder	q(String value)	API name: q
final FleetSearchRequest.Builder	query(Query value)	Defines the search definition using the Query DSL.
final FleetSearchRequest.Builder	query(QueryVariant value)	Defines the search definition using the Query DSL.
final FleetSearchRequest.Builder	query(Function<Query.Builder,ObjectBuilder<Query>> fn)	Defines the search definition using the Query DSL.
final FleetSearchRequest.Builder	requestCache(Boolean value)	API name: request_cache
final FleetSearchRequest.Builder	rescore(Rescore value, Rescore... values)	API name: rescore
final FleetSearchRequest.Builder	rescore(RescoreVariant value, RescoreVariant... values)	API name: rescore
final FleetSearchRequest.Builder	rescore(Function<Rescore.Builder,ObjectBuilder<Rescore>> fn)	API name: rescore
final FleetSearchRequest.Builder	rescore(List<Rescore> list)	API name: rescore
final FleetSearchRequest.Builder	routing(String value)	API name: routing
final FleetSearchRequest.Builder	runtimeMappings(String key, RuntimeField value)	Defines one or more runtime fields in the search request.
final FleetSearchRequest.Builder	runtimeMappings(String key, Function<RuntimeField.Builder,ObjectBuilder<RuntimeField>> fn)	Defines one or more runtime fields in the search request.
final FleetSearchRequest.Builder	runtimeMappings(Map<String,RuntimeField> map)	Defines one or more runtime fields in the search request.
final FleetSearchRequest.Builder	scriptFields(String key, ScriptField value)	Retrieve a script evaluation (based on different fields) for each hit.
final FleetSearchRequest.Builder	scriptFields(String key, Function<ScriptField.Builder,ObjectBuilder<ScriptField>> fn)	Retrieve a script evaluation (based on different fields) for each hit.
final FleetSearchRequest.Builder	scriptFields(Map<String,ScriptField> map)	Retrieve a script evaluation (based on different fields) for each hit.
final FleetSearchRequest.Builder	scroll(Time value)	API name: scroll
final FleetSearchRequest.Builder	scroll(Function<Time.Builder,ObjectBuilder<Time>> fn)	API name: scroll
final FleetSearchRequest.Builder	searchAfter(boolean value, boolean... values)	API name: search_after
final FleetSearchRequest.Builder	searchAfter(double value, double... values)	API name: search_after
final FleetSearchRequest.Builder	searchAfter(long value, long... values)	API name: search_after
final FleetSearchRequest.Builder	searchAfter(FieldValue value, FieldValue... values)	API name: search_after
final FleetSearchRequest.Builder	searchAfter(String value, String... values)	API name: search_after
final FleetSearchRequest.Builder	searchAfter(Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)	API name: search_after
final FleetSearchRequest.Builder	searchAfter(List<FieldValue> list)	API name: search_after
final FleetSearchRequest.Builder	searchType(SearchType value)	API name: search_type
protected FleetSearchRequest.Builder	self()
final FleetSearchRequest.Builder	seqNoPrimaryTerm(Boolean value)	If true, returns sequence number and primary term of the last modification of each hit.
final FleetSearchRequest.Builder	size(Integer value)	The number of hits to return.
final FleetSearchRequest.Builder	slice(SlicedScroll value)	API name: slice
final FleetSearchRequest.Builder	slice(Function<SlicedScroll.Builder,ObjectBuilder<SlicedScroll>> fn)	API name: slice
final FleetSearchRequest.Builder	sort(SortOptions value, SortOptions... values)	API name: sort
final FleetSearchRequest.Builder	sort(Function<SortOptions.Builder,ObjectBuilder<SortOptions>> fn)	API name: sort
final FleetSearchRequest.Builder	sort(List<SortOptions> list)	API name: sort
final FleetSearchRequest.Builder	source(SourceConfig value)	Indicates which source fields are returned for matching documents.
final FleetSearchRequest.Builder	source(Function<SourceConfig.Builder,ObjectBuilder<SourceConfig>> fn)	Indicates which source fields are returned for matching documents.
final FleetSearchRequest.Builder	stats(String value, String... values)	Stats groups to associate with the search.
final FleetSearchRequest.Builder	stats(List<String> list)	Stats groups to associate with the search.
final FleetSearchRequest.Builder	storedFields(String value, String... values)	List of stored fields to return as part of a hit.
final FleetSearchRequest.Builder	storedFields(List<String> list)	List of stored fields to return as part of a hit.
final FleetSearchRequest.Builder	suggest(Suggester value)	API name: suggest
final FleetSearchRequest.Builder	suggest(Function<Suggester.Builder,ObjectBuilder<Suggester>> fn)	API name: suggest
final FleetSearchRequest.Builder	terminateAfter(Long value)	Maximum number of documents to collect for each shard.
final FleetSearchRequest.Builder	timeout(String value)	Specifies the period of time to wait for a response from each shard.
final FleetSearchRequest.Builder	trackScores(Boolean value)	If true, calculate and return document scores, even if the scores are not used for sorting.
final FleetSearchRequest.Builder	trackTotalHits(TrackHits value)	Number of hits matching the query to count accurately.
final FleetSearchRequest.Builder	trackTotalHits(Function<TrackHits.Builder,ObjectBuilder<TrackHits>> fn)	Number of hits matching the query to count accurately.
final FleetSearchRequest.Builder	version(Boolean value)	If true, returns document version as part of a hit.
final FleetSearchRequest.Builder	waitForCheckpoints(Long value, Long... values)	A comma separated list of checkpoints.
final FleetSearchRequest.Builder	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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

source

public final FleetSearchRequest.Builder source(@Nullable
 SourceConfig value)

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

public final FleetSearchRequest.Builder aggregations(Map<String,Aggregation> map)

API name: aggregations

Adds all entries of map to aggregations.

aggregations

public final FleetSearchRequest.Builder aggregations(String key,
 Aggregation value)

API name: aggregations

Adds an entry to aggregations.

aggregations

public final FleetSearchRequest.Builder aggregations(String key,
 AggregationVariant value)

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

public final FleetSearchRequest.Builder allowNoIndices(@Nullable
 Boolean value)

API name: allow_no_indices

allowPartialSearchResults

public final FleetSearchRequest.Builder allowPartialSearchResults(@Nullable
 Boolean value)

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 setting search.default_allow_partial_results, which is true by default.

API name: allow_partial_search_results

analyzeWildcard

public final FleetSearchRequest.Builder analyzeWildcard(@Nullable
 Boolean value)

API name: analyze_wildcard

analyzer

public final FleetSearchRequest.Builder analyzer(@Nullable
 String value)

API name: analyzer

batchedReduceSize

public final FleetSearchRequest.Builder batchedReduceSize(@Nullable
 Long value)

API name: batched_reduce_size

ccsMinimizeRoundtrips

public final FleetSearchRequest.Builder ccsMinimizeRoundtrips(@Nullable
 Boolean value)

API name: ccs_minimize_roundtrips

collapse

public final FleetSearchRequest.Builder collapse(@Nullable
 FieldCollapse value)

API name: collapse

collapse

public final FleetSearchRequest.Builder collapse(Function<FieldCollapse.Builder,ObjectBuilder<FieldCollapse>> fn)

API name: collapse

defaultOperator

public final FleetSearchRequest.Builder defaultOperator(@Nullable
 Operator value)

API name: default_operator

df

public final FleetSearchRequest.Builder df(@Nullable
 String value)

API name: df

docvalueFields

public final FleetSearchRequest.Builder docvalueFields(List<FieldAndFormat> list)

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 to docvalueFields.

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

public final FleetSearchRequest.Builder expandWildcards(List<ExpandWildcard> list)

API name: expand_wildcards

Adds all elements of list to expandWildcards.

expandWildcards

public final FleetSearchRequest.Builder expandWildcards(ExpandWildcard value,
 ExpandWildcard... values)

API name: expand_wildcards

Adds one or more values to expandWildcards.

explain

public final FleetSearchRequest.Builder explain(@Nullable
 Boolean value)

If true, returns detailed information about score computation as part of a hit.

API name: explain

ext

public final FleetSearchRequest.Builder ext(Map<String,JsonData> map)

Configuration of search extensions defined by Elasticsearch plugins.

API name: ext

Adds all entries of map to ext.

ext

public final FleetSearchRequest.Builder ext(String key,
 JsonData value)

Configuration of search extensions defined by Elasticsearch plugins.

API name: ext

Adds an entry to ext.

fields

public final FleetSearchRequest.Builder fields(List<FieldAndFormat> list)

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 to fields.

fields

public final FleetSearchRequest.Builder fields(FieldAndFormat value,
 FieldAndFormat... values)

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

public final FleetSearchRequest.Builder from(@Nullable
 Integer value)

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

public final FleetSearchRequest.Builder highlight(@Nullable
 Highlight value)

API name: highlight

highlight

public final FleetSearchRequest.Builder highlight(Function<Highlight.Builder,ObjectBuilder<Highlight>> fn)

API name: highlight

ignoreThrottled

public final FleetSearchRequest.Builder ignoreThrottled(@Nullable
 Boolean value)

API name: ignore_throttled

ignoreUnavailable

public final FleetSearchRequest.Builder ignoreUnavailable(@Nullable
 Boolean value)

API name: ignore_unavailable

index

public final FleetSearchRequest.Builder index(String value)

Required - A single target to search. If the target is an index alias, it must resolve to a single index.

API name: index

indicesBoost

public final FleetSearchRequest.Builder indicesBoost(List<NamedValue<Double>> list)

Boosts the _score of documents from specified indices.

API name: indices_boost

Adds all elements of list to indicesBoost.

indicesBoost

@SafeVarargs
public final FleetSearchRequest.Builder indicesBoost(NamedValue<Double> value,
 NamedValue<Double>... values)

Boosts the _score of documents from specified indices.

API name: indices_boost

Adds one or more values to indicesBoost.

lenient

public final FleetSearchRequest.Builder lenient(@Nullable
 Boolean value)

API name: lenient

maxConcurrentShardRequests

public final FleetSearchRequest.Builder maxConcurrentShardRequests(@Nullable
 Integer value)

API name: max_concurrent_shard_requests

minScore

public final FleetSearchRequest.Builder minScore(@Nullable
 Double value)

Minimum _score for matching documents. Documents with a lower _score are not included in search results and results collected by aggregations.

API name: min_score

pit

public final FleetSearchRequest.Builder pit(@Nullable
 PointInTimeReference value)

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

public final FleetSearchRequest.Builder postFilter(@Nullable
 Query value)

API name: post_filter

postFilter

public final FleetSearchRequest.Builder postFilter(Function<Query.Builder,ObjectBuilder<Query>> fn)

API name: post_filter

postFilter

public final FleetSearchRequest.Builder postFilter(QueryVariant value)

API name: post_filter

preFilterShardSize

public final FleetSearchRequest.Builder preFilterShardSize(@Nullable
 Long value)

API name: pre_filter_shard_size

preference

public final FleetSearchRequest.Builder preference(@Nullable
 String value)

API name: preference

profile

public final FleetSearchRequest.Builder profile(@Nullable
 Boolean value)

API name: profile

q

public final FleetSearchRequest.Builder q(@Nullable
 String value)

API name: q

query

public final FleetSearchRequest.Builder query(@Nullable
 Query value)

Defines the search definition using the Query DSL.

API name: query

query

public final FleetSearchRequest.Builder query(Function<Query.Builder,ObjectBuilder<Query>> fn)

Defines the search definition using the Query DSL.

API name: query

query

public final FleetSearchRequest.Builder query(QueryVariant value)

Defines the search definition using the Query DSL.

API name: query

requestCache

public final FleetSearchRequest.Builder requestCache(@Nullable
 Boolean value)

API name: request_cache

rescore

public final FleetSearchRequest.Builder rescore(List<Rescore> list)

API name: rescore

Adds all elements of list to rescore.

rescore

public final FleetSearchRequest.Builder rescore(Rescore value,
 Rescore... values)

API name: rescore

Adds one or more values to rescore.

rescore

public final FleetSearchRequest.Builder rescore(RescoreVariant value,
 RescoreVariant... values)

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

public final FleetSearchRequest.Builder routing(@Nullable
 String value)

API name: routing

runtimeMappings

public final FleetSearchRequest.Builder runtimeMappings(Map<String,RuntimeField> map)

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 to runtimeMappings.

runtimeMappings

public final FleetSearchRequest.Builder runtimeMappings(String key,
 RuntimeField value)

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

public final FleetSearchRequest.Builder scriptFields(Map<String,ScriptField> map)

Retrieve a script evaluation (based on different fields) for each hit.

API name: script_fields

Adds all entries of map to scriptFields.

scriptFields

public final FleetSearchRequest.Builder scriptFields(String key,
 ScriptField value)

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

public final FleetSearchRequest.Builder scroll(@Nullable
 Time value)

API name: scroll

scroll

public final FleetSearchRequest.Builder scroll(Function<Time.Builder,ObjectBuilder<Time>> fn)

API name: scroll

searchAfter

public final FleetSearchRequest.Builder searchAfter(List<FieldValue> list)

API name: search_after

Adds all elements of list to searchAfter.

searchAfter

public final FleetSearchRequest.Builder searchAfter(FieldValue value,
 FieldValue... values)

API name: search_after

Adds one or more values to searchAfter.

searchAfter

public final FleetSearchRequest.Builder searchAfter(String value,
 String... values)

API name: search_after

Adds one or more values to searchAfter.

searchAfter

public final FleetSearchRequest.Builder searchAfter(long value,
 long... values)

API name: search_after

Adds one or more values to searchAfter.

searchAfter

public final FleetSearchRequest.Builder searchAfter(double value,
 double... values)

API name: search_after

Adds one or more values to searchAfter.

searchAfter

public final FleetSearchRequest.Builder searchAfter(boolean value,
 boolean... values)

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

public final FleetSearchRequest.Builder searchType(@Nullable
 SearchType value)

API name: search_type

seqNoPrimaryTerm

public final FleetSearchRequest.Builder seqNoPrimaryTerm(@Nullable
 Boolean value)

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

public final FleetSearchRequest.Builder size(@Nullable
 Integer value)

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

public final FleetSearchRequest.Builder slice(@Nullable
 SlicedScroll value)

API name: slice

slice

public final FleetSearchRequest.Builder slice(Function<SlicedScroll.Builder,ObjectBuilder<SlicedScroll>> fn)

API name: slice

sort

public final FleetSearchRequest.Builder sort(List<SortOptions> list)

API name: sort

Adds all elements of list to sort.

sort

public final FleetSearchRequest.Builder sort(SortOptions value,
 SortOptions... values)

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

public final FleetSearchRequest.Builder stats(List<String> list)

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 to stats.

stats

public final FleetSearchRequest.Builder stats(String value,
 String... values)

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

public final FleetSearchRequest.Builder storedFields(List<String> list)

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 to storedFields.

storedFields

public final FleetSearchRequest.Builder storedFields(String value,
 String... values)

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

public final FleetSearchRequest.Builder suggest(@Nullable
 Suggester value)

API name: suggest

suggest

public final FleetSearchRequest.Builder suggest(Function<Suggester.Builder,ObjectBuilder<Suggester>> fn)

API name: suggest

terminateAfter

public final FleetSearchRequest.Builder terminateAfter(@Nullable
 Long value)

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

public final FleetSearchRequest.Builder timeout(@Nullable
 String value)

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

public final FleetSearchRequest.Builder trackScores(@Nullable
 Boolean value)

If true, calculate and return document scores, even if the scores are not used for sorting.

API name: track_scores

trackTotalHits

public final FleetSearchRequest.Builder trackTotalHits(@Nullable
 TrackHits value)

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

public final FleetSearchRequest.Builder version(@Nullable
 Boolean value)

If true, returns document version as part of a hit.

API name: version

waitForCheckpoints

public final FleetSearchRequest.Builder waitForCheckpoints(List<Long> list)

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 to waitForCheckpoints.

waitForCheckpoints

public final FleetSearchRequest.Builder waitForCheckpoints(Long value,
 Long... values)

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

protected FleetSearchRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<FleetSearchRequest.Builder>

build

public FleetSearchRequest build()

Builds a FleetSearchRequest.

Specified by:

build in interface ObjectBuilder<FleetSearchRequest>

Throws:

NullPointerException - if some of the required fields are null.