Class FleetSearchRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.fleet.FleetSearchRequest
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class FleetSearchRequest
extends RequestBase
implements JsonpSerializable
The purpose of the fleet search api is to provide a search api where the
search will only be executed after provided checkpoint has been processed and
is visible for searches inside of Elasticsearch.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<FleetSearchRequest>
Json deserializer forFleetSearchRequest
static final SimpleEndpoint<FleetSearchRequest,
?> Endpoint "fleet.search
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Map<String,
Aggregation> API name:aggregations
final Boolean
API name:allow_no_indices
final Boolean
If true, returns partial results if there are shard request timeouts or shard failures.final String
analyzer()
API name:analyzer
final Boolean
API name:analyze_wildcard
final Long
API name:batched_reduce_size
final Boolean
API name:ccs_minimize_roundtrips
final FieldCollapse
collapse()
API name:collapse
static <TDocument>
Endpoint<FleetSearchRequest,FleetSearchResponse<TDocument>, ErrorResponse> createSearchEndpoint
(JsonpDeserializer<TDocument> tDocumentDeserializer) Create an "fleet.search
" endpoint.final Operator
API name:default_operator
final String
df()
API name:df
final List<FieldAndFormat>
Array of wildcard (*) patterns.final List<ExpandWildcard>
API name:expand_wildcards
final Boolean
explain()
If true, returns detailed information about score computation as part of a hit.ext()
Configuration of search extensions defined by Elasticsearch plugins.final List<FieldAndFormat>
fields()
Array of wildcard (*) patterns.final Integer
from()
Starting document offset.final Highlight
API name:highlight
final Boolean
API name:ignore_throttled
final Boolean
API name:ignore_unavailable
final String
index()
Required - A single target to search.Boosts the _score of documents from specified indices.final Boolean
lenient()
API name:lenient
final Long
API name:max_concurrent_shard_requests
final String
API name:min_compatible_shard_node
final Double
minScore()
Minimum _score for matching documents.static FleetSearchRequest
final PointInTimeReference
pit()
Limits the search to a point in time (PIT).final Query
API name:post_filter
final String
API name:preference
final Long
API name:pre_filter_shard_size
final Boolean
profile()
API name:profile
final String
q()
API name:q
final Query
query()
Defines the search definition using the Query DSL.final Boolean
API name:request_cache
rescore()
API name:rescore
final String
routing()
API name:routing
final Map<String,
RuntimeField> Defines one or more runtime fields in the search request.final Map<String,
ScriptField> Retrieve a script evaluation (based on different fields) for each hit.final Time
scroll()
API name:scroll
final List<FieldValue>
API name:search_after
final SearchType
API name:search_type
final Boolean
If true, returns sequence number and primary term of the last modification of each hit.void
serialize
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) Serialize this object to JSON.protected void
serializeInternal
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static void
final Integer
size()
The number of hits to return.final SlicedScroll
slice()
API name:slice
final List<SortOptions>
sort()
API name:sort
final SourceConfig
source()
Indicates which source fields are returned for matching documents.stats()
Stats groups to associate with the search.List of stored fields to return as part of a hit.final Suggester
suggest()
API name:suggest
final Long
Maximum number of documents to collect for each shard.final String
timeout()
Specifies the period of time to wait for a response from each shard.final Boolean
If true, calculate and return document scores, even if the scores are not used for sorting.final TrackHits
Number of hits matching the query to count accurately.final Boolean
version()
If true, returns document version as part of a hit.A comma separated list of checkpoints.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_DESERIALIZER
Json deserializer forFleetSearchRequest
-
_ENDPOINT
Endpoint "fleet.search
".
-
-
Method Details
-
of
public static FleetSearchRequest of(Function<FleetSearchRequest.Builder, ObjectBuilder<FleetSearchRequest>> fn) -
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
-
aggregations
API name:aggregations
-
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
-
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
-
expandWildcards
API name:expand_wildcards
-
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
-
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
-
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
-
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
-
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
-
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
-
requestCache
API name:request_cache
-
rescore
API name:rescore
-
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
-
scriptFields
Retrieve a script evaluation (based on different fields) for each hit.API name:
script_fields
-
scroll
API name:scroll
-
searchAfter
API name:search_after
-
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
-
sort
API name:sort
-
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
-
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
-
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
-
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
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupFleetSearchRequestDeserializer
protected static void setupFleetSearchRequestDeserializer(ObjectDeserializer<FleetSearchRequest.Builder> op) -
createSearchEndpoint
public static <TDocument> Endpoint<FleetSearchRequest,FleetSearchResponse<TDocument>, createSearchEndpointErrorResponse> (JsonpDeserializer<TDocument> tDocumentDeserializer) Create an "fleet.search
" endpoint.
-