Class QueryRequest.Builder
- All Implemented Interfaces:
WithJson<QueryRequest.Builder>
,ObjectBuilder<QueryRequest>
- Enclosing class:
- QueryRequest
QueryRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aQueryRequest
.final QueryRequest.Builder
Default catalog (cluster) for queries.final QueryRequest.Builder
If true, the results in a columnar fashion: one row represents all the values of a certain column from the current page of results.final QueryRequest.Builder
API name:cursor
final QueryRequest.Builder
The maximum number of rows (or entries) to return in one responsefinal QueryRequest.Builder
fieldMultiValueLeniency
(Boolean value) Throw an exception when encountering multiple values for a field (default) or be lenient and return the first value from the list (without any guarantees of what that will be - typically the first in natural ascending order).final QueryRequest.Builder
Optional Elasticsearch query DSL for additional filtering.final QueryRequest.Builder
Optional Elasticsearch query DSL for additional filtering.final QueryRequest.Builder
a short version of the Accept header, e.g.final QueryRequest.Builder
indexUsingFrozen
(Boolean value) If true, the search can run on frozen indices.final QueryRequest.Builder
Retention period for an async or saved synchronous search.final QueryRequest.Builder
Retention period for an async or saved synchronous search.final QueryRequest.Builder
keepOnCompletion
(Boolean value) If true, Elasticsearch stores synchronous searches if you also specify the wait_for_completion_timeout parameter.final QueryRequest.Builder
pageTimeout
(Time value) The timeout before a pagination request fails.final QueryRequest.Builder
The timeout before a pagination request fails.final QueryRequest.Builder
Values for parameters in the query.final QueryRequest.Builder
Values for parameters in the query.final QueryRequest.Builder
SQL query to executefinal QueryRequest.Builder
requestTimeout
(Time value) The timeout before the request fails.final QueryRequest.Builder
The timeout before the request fails.final QueryRequest.Builder
runtimeMappings
(String key, RuntimeField value) Defines one or more runtime fields in the search request.final QueryRequest.Builder
Defines one or more runtime fields in the search request.final QueryRequest.Builder
runtimeMappings
(Map<String, RuntimeField> map) Defines one or more runtime fields in the search request.protected QueryRequest.Builder
self()
final QueryRequest.Builder
Time-zone in ISO 8601 used for executing the query on the server.final QueryRequest.Builder
waitForCompletionTimeout
(Time value) Period to wait for complete results.final QueryRequest.Builder
Period to wait for complete results.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
-
catalog
Default catalog (cluster) for queries. If unspecified, the queries execute on the data in the local cluster only.API name:
catalog
-
columnar
If true, the results in a columnar fashion: one row represents all the values of a certain column from the current page of results.API name:
columnar
-
cursor
API name:cursor
-
fetchSize
The maximum number of rows (or entries) to return in one responseAPI name:
fetch_size
-
fieldMultiValueLeniency
Throw an exception when encountering multiple values for a field (default) or be lenient and return the first value from the list (without any guarantees of what that will be - typically the first in natural ascending order).API name:
field_multi_value_leniency
-
filter
Optional Elasticsearch query DSL for additional filtering.API name:
filter
-
filter
Optional Elasticsearch query DSL for additional filtering.API name:
filter
-
format
a short version of the Accept header, e.g. json, yamlAPI name:
format
-
indexUsingFrozen
If true, the search can run on frozen indices. Defaults to false.API name:
index_using_frozen
-
keepAlive
Retention period for an async or saved synchronous search.API name:
keep_alive
-
keepAlive
Retention period for an async or saved synchronous search.API name:
keep_alive
-
keepOnCompletion
If true, Elasticsearch stores synchronous searches if you also specify the wait_for_completion_timeout parameter. If false, Elasticsearch only stores async searches that don’t finish before the wait_for_completion_timeout.API name:
keep_on_completion
-
pageTimeout
The timeout before a pagination request fails.API name:
page_timeout
-
pageTimeout
The timeout before a pagination request fails.API name:
page_timeout
-
params
Values for parameters in the query.API name:
params
Adds all entries of
map
toparams
. -
params
Values for parameters in the query.API name:
params
Adds an entry to
params
. -
query
SQL query to executeAPI name:
query
-
requestTimeout
The timeout before the request fails.API name:
request_timeout
-
requestTimeout
The timeout before the request fails.API name:
request_timeout
-
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 QueryRequest.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. -
timeZone
Time-zone in ISO 8601 used for executing the query on the server. More information available here.API name:
time_zone
-
waitForCompletionTimeout
Period to wait for complete results. Defaults to no timeout, meaning the request waits for complete search results. If the search doesn’t finish within this period, the search becomes async.API name:
wait_for_completion_timeout
-
waitForCompletionTimeout
public final QueryRequest.Builder waitForCompletionTimeout(Function<Time.Builder, ObjectBuilder<Time>> fn) Period to wait for complete results. Defaults to no timeout, meaning the request waits for complete search results. If the search doesn’t finish within this period, the search becomes async.API name:
wait_for_completion_timeout
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<QueryRequest.Builder>
-
build
Builds aQueryRequest
.- Specified by:
build
in interfaceObjectBuilder<QueryRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-