Class QueryRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch.sql.QueryRequest.Builder
- All Implemented Interfaces:
ObjectBuilder<QueryRequest>
- Enclosing class:
- QueryRequest
public static class QueryRequest.Builder extends ObjectBuilderBase 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
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
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
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
timeZone(java.lang.String value)
Time-zone in ISO 8601 used for executing the query on the server.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
-
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
-
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
-
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
-
timeZone
Time-zone in ISO 8601 used for executing the query on the server. More information available here.API name:
time_zone
-
build
Builds aQueryRequest
.- Specified by:
build
in interfaceObjectBuilder<QueryRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-