Class QueryRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<QueryRequest.Builder>
co.elastic.clients.elasticsearch.sql.QueryRequest.Builder
- All Implemented Interfaces:
WithJson<QueryRequest.Builder>
,ObjectBuilder<QueryRequest>
- Enclosing class:
- QueryRequest
public static class QueryRequest.Builder extends WithJsonObjectBuilderBase<QueryRequest.Builder> implements ObjectBuilder<QueryRequest>
Builder for
QueryRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description QueryRequest
build()
Builds aQueryRequest
.QueryRequest.Builder
catalog(java.lang.String value)
Default catalog (cluster) for queries.QueryRequest.Builder
columnar(java.lang.Boolean value)
API name:columnar
QueryRequest.Builder
cursor(java.lang.String value)
API name:cursor
QueryRequest.Builder
fetchSize(java.lang.Integer value)
The maximum number of rows (or entries) to return in one responseQueryRequest.Builder
fieldMultiValueLeniency(java.lang.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).QueryRequest.Builder
filter(Query value)
Optional Elasticsearch query DSL for additional filtering.QueryRequest.Builder
filter(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)
Optional Elasticsearch query DSL for additional filtering.QueryRequest.Builder
format(java.lang.String value)
a short version of the Accept header, e.g.QueryRequest.Builder
indexUsingFrozen(java.lang.Boolean value)
If true, the search can run on frozen indices.QueryRequest.Builder
keepAlive(Time value)
Retention period for an async or saved synchronous search.QueryRequest.Builder
keepAlive(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
Retention period for an async or saved synchronous search.QueryRequest.Builder
keepOnCompletion(java.lang.Boolean value)
If true, Elasticsearch stores synchronous searches if you also specify the wait_for_completion_timeout parameter.QueryRequest.Builder
pageTimeout(Time value)
The timeout before a pagination request fails.QueryRequest.Builder
pageTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
The timeout before a pagination request fails.QueryRequest.Builder
params(java.lang.String key, JsonData value)
Values for parameters in the query.QueryRequest.Builder
params(java.util.Map<java.lang.String,JsonData> map)
Values for parameters in the query.QueryRequest.Builder
query(java.lang.String value)
SQL query to executeQueryRequest.Builder
requestTimeout(Time value)
The timeout before the request fails.QueryRequest.Builder
requestTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
The timeout before the request fails.QueryRequest.Builder
runtimeMappings(java.lang.String key, java.util.List<RuntimeField> value)
Defines one or more runtime fields in the search request.QueryRequest.Builder
runtimeMappings(java.util.Map<java.lang.String,java.util.List<RuntimeField>> map)
Defines one or more runtime fields in the search request.protected QueryRequest.Builder
self()
QueryRequest.Builder
timeZone(java.lang.String value)
Time-zone in ISO 8601 used for executing the query on the server.QueryRequest.Builder
waitForCompletionTimeout(Time value)
Period to wait for complete results.QueryRequest.Builder
waitForCompletionTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
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
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
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
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
public final QueryRequest.Builder filter(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)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
public final QueryRequest.Builder keepAlive(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)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
public final QueryRequest.Builder pageTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)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
public final QueryRequest.Builder requestTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)The timeout before the request fails.API name:
request_timeout
-
runtimeMappings
public final QueryRequest.Builder runtimeMappings(java.util.Map<java.lang.String,java.util.List<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
toruntimeMappings
. -
runtimeMappings
public final QueryRequest.Builder runtimeMappings(java.lang.String key, java.util.List<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
. -
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(java.util.function.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 classWithJsonObjectBuilderBase<QueryRequest.Builder>
-
build
Builds aQueryRequest
.- Specified by:
build
in interfaceObjectBuilder<QueryRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-