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:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
FleetSearchRequest.Builder
Builder forFleetSearchRequest
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<FleetSearchRequest>
_DESERIALIZER
Json deserializer forFleetSearchRequest
static SimpleEndpoint<FleetSearchRequest,?>
_ENDPOINT
Endpoint "fleet.search
". -
Method Summary
Modifier and Type Method Description java.util.Map<java.lang.String,Aggregation>
aggregations()
API name:aggregations
java.lang.Boolean
allowNoIndices()
API name:allow_no_indices
java.lang.Boolean
allowPartialSearchResults()
If true, returns partial results if there are shard request timeouts or shard failures.java.lang.String
analyzer()
API name:analyzer
java.lang.Boolean
analyzeWildcard()
API name:analyze_wildcard
java.lang.Long
batchedReduceSize()
API name:batched_reduce_size
java.lang.Boolean
ccsMinimizeRoundtrips()
API name:ccs_minimize_roundtrips
FieldCollapse
collapse()
API name:collapse
static <TDocument>
Endpoint<FleetSearchRequest,FleetSearchResponse<TDocument>,ErrorResponse>createSearchEndpoint(JsonpDeserializer<TDocument> tDocumentDeserializer)
Create an "fleet.search
" endpoint.Operator
defaultOperator()
API name:default_operator
java.lang.String
df()
API name:df
java.util.List<FieldAndFormat>
docvalueFields()
Array of wildcard (*) patterns.java.util.List<ExpandWildcard>
expandWildcards()
API name:expand_wildcards
java.lang.Boolean
explain()
If true, returns detailed information about score computation as part of a hit.java.util.List<FieldAndFormat>
fields()
Array of wildcard (*) patterns.java.lang.Integer
from()
Starting document offset.Highlight
highlight()
API name:highlight
java.lang.Boolean
ignoreThrottled()
API name:ignore_throttled
java.lang.Boolean
ignoreUnavailable()
API name:ignore_unavailable
java.lang.String
index()
Required - A single target to search.java.util.List<java.util.Map<java.lang.String,java.lang.Double>>
indicesBoost()
Boosts the _score of documents from specified indices.java.lang.Boolean
lenient()
API name:lenient
java.lang.Long
maxConcurrentShardRequests()
API name:max_concurrent_shard_requests
java.lang.String
minCompatibleShardNode()
API name:min_compatible_shard_node
java.lang.Double
minScore()
Minimum _score for matching documents.static FleetSearchRequest
of(java.util.function.Function<FleetSearchRequest.Builder,ObjectBuilder<FleetSearchRequest>> fn)
PointInTimeReference
pit()
Limits the search to a point in time (PIT).Query
postFilter()
API name:post_filter
java.lang.String
preference()
API name:preference
java.lang.Long
preFilterShardSize()
API name:pre_filter_shard_size
java.lang.Boolean
profile()
API name:profile
java.lang.String
q()
API name:q
Query
query()
Defines the search definition using the Query DSL.java.lang.Boolean
requestCache()
API name:request_cache
java.util.List<Rescore>
rescore()
API name:rescore
java.lang.String
routing()
API name:routing
java.util.Map<java.lang.String,java.util.List<RuntimeField>>
runtimeMappings()
Defines one or more runtime fields in the search request.java.util.Map<java.lang.String,ScriptField>
scriptFields()
Retrieve a script evaluation (based on different fields) for each hit.Time
scroll()
API name:scroll
java.util.List<java.lang.String>
searchAfter()
API name:search_after
SearchType
searchType()
API name:search_type
java.lang.Boolean
seqNoPrimaryTerm()
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
setupFleetSearchRequestDeserializer(ObjectDeserializer<FleetSearchRequest.Builder> op)
java.lang.Integer
size()
The number of hits to return.SlicedScroll
slice()
API name:slice
java.util.List<SortOptions>
sort()
API name:sort
SourceConfig
source()
Indicates which source fields are returned for matching documents.java.util.List<java.lang.String>
stats()
Stats groups to associate with the search.java.util.List<java.lang.String>
storedFields()
List of stored fields to return as part of a hit.Suggester
suggest()
API name:suggest
java.lang.Long
terminateAfter()
Maximum number of documents to collect for each shard.java.lang.String
timeout()
Specifies the period of time to wait for a response from each shard.java.lang.Boolean
trackScores()
If true, calculate and return document scores, even if the scores are not used for sorting.TrackHits
trackTotalHits()
Number of hits matching the query to count accurately.java.lang.Boolean
version()
If true, returns document version as part of a hit.java.util.List<java.lang.Long>
waitForCheckpoints()
A comma separated list of checkpoints.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Field Details
-
_DESERIALIZER
Json deserializer forFleetSearchRequest
-
_ENDPOINT
Endpoint "fleet.search
".
-
-
Method Details
-
of
public static FleetSearchRequest of(java.util.function.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
@Nullable public final java.lang.Boolean allowNoIndices()API name:allow_no_indices
-
allowPartialSearchResults
@Nullable public final java.lang.Boolean 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
@Nullable public final java.lang.Boolean analyzeWildcard()API name:analyze_wildcard
-
analyzer
@Nullable public final java.lang.String analyzer()API name:analyzer
-
batchedReduceSize
@Nullable public final java.lang.Long batchedReduceSize()API name:batched_reduce_size
-
ccsMinimizeRoundtrips
@Nullable public final java.lang.Boolean ccsMinimizeRoundtrips()API name:ccs_minimize_roundtrips
-
collapse
API name:collapse
-
defaultOperator
API name:default_operator
-
df
@Nullable public final java.lang.String 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
@Nullable public final java.lang.Boolean explain()If true, returns detailed information about score computation as part of a hit.API name:
explain
-
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
@Nullable public final java.lang.Integer 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
@Nullable public final java.lang.Boolean ignoreThrottled()API name:ignore_throttled
-
index
public final java.lang.String 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
public final java.util.List<java.util.Map<java.lang.String,java.lang.Double>> indicesBoost()Boosts the _score of documents from specified indices.API name:
indices_boost
-
lenient
@Nullable public final java.lang.Boolean lenient()API name:lenient
-
maxConcurrentShardRequests
@Nullable public final java.lang.Long maxConcurrentShardRequests()API name:max_concurrent_shard_requests
-
minCompatibleShardNode
@Nullable public final java.lang.String minCompatibleShardNode()API name:min_compatible_shard_node
-
minScore
@Nullable public final java.lang.Double 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
@Nullable public final java.lang.Long preFilterShardSize()API name:pre_filter_shard_size
-
preference
@Nullable public final java.lang.String preference()API name:preference
-
profile
@Nullable public final java.lang.Boolean profile()API name:profile
-
q
@Nullable public final java.lang.String q()API name:q
-
query
Defines the search definition using the Query DSL.API name:
query
-
requestCache
@Nullable public final java.lang.Boolean requestCache()API name:request_cache
-
rescore
API name:rescore
-
routing
@Nullable public final java.lang.String 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
public final java.util.List<java.lang.String> searchAfter()API name:search_after
-
searchType
API name:search_type
-
seqNoPrimaryTerm
@Nullable public final java.lang.Boolean 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
@Nullable public final java.lang.Integer 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
public final java.util.List<java.lang.String> 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
public final java.util.List<java.lang.String> 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
@Nullable public final java.lang.Long 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
@Nullable public final java.lang.String 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
@Nullable public final java.lang.Boolean 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
@Nullable public final java.lang.Boolean version()If true, returns document version as part of a hit.API name:
version
-
waitForCheckpoints
public final java.util.List<java.lang.Long> 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>,ErrorResponse> createSearchEndpoint(JsonpDeserializer<TDocument> tDocumentDeserializer)Create an "fleet.search
" endpoint.
-