Class QueryRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.sql.QueryRequest
- All Implemented Interfaces:
ElasticsearchCommonRequest
,JsonpSerializable
@JsonpDeserializable public final class QueryRequest extends RequestBase implements JsonpSerializable
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
QueryRequest.Builder
Builder forQueryRequest
.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<QueryRequest>
_DESERIALIZER
Json deserializer forQueryRequest
static Endpoint<QueryRequest,QueryResponse,ElasticsearchError>
ENDPOINT
Endpoint "sql.query
". -
Constructor Summary
Constructors Constructor Description QueryRequest(QueryRequest.Builder builder)
QueryRequest(java.util.function.Function<QueryRequest.Builder,QueryRequest.Builder> fn)
-
Method Summary
Modifier and Type Method Description java.lang.Boolean
columnar()
API name:columnar
java.lang.String
cursor()
API name:cursor
java.lang.Integer
fetchSize()
The maximum number of rows (or entries) to return in one responsejava.lang.Boolean
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).Query
filter()
Optional Elasticsearch query DSL for additional filtering.java.lang.String
format()
a short version of the Accept header, e.g.java.lang.String
pageTimeout()
The timeout before a pagination request fails.java.lang.String
query()
SQL query to executejava.lang.String
requestTimeout()
The timeout before the request fails.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
setupQueryRequestDeserializer(DelegatingDeserializer<QueryRequest.Builder> op)
java.lang.String
timeZone()
Time-zone in ISO 8601 used for executing the query on the server.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
_DESERIALIZER
Json deserializer forQueryRequest
-
ENDPOINT
Endpoint "sql.query
".
-
-
Constructor Details
-
QueryRequest
-
QueryRequest
-
-
Method Details
-
format
@Nullable public java.lang.String format()a short version of the Accept header, e.g. json, yamlAPI name:
format
-
columnar
@Nullable public java.lang.Boolean columnar()API name:columnar
-
cursor
@Nullable public java.lang.String cursor()API name:cursor
-
fetchSize
@Nullable public java.lang.Integer fetchSize()The maximum number of rows (or entries) to return in one responseAPI name:
fetch_size
-
filter
Optional Elasticsearch query DSL for additional filtering.API name:
filter
-
query
@Nullable public java.lang.String query()SQL query to executeAPI name:
query
-
requestTimeout
@Nullable public java.lang.String requestTimeout()The timeout before the request fails.API name:
request_timeout
-
pageTimeout
@Nullable public java.lang.String pageTimeout()The timeout before a pagination request fails.API name:
page_timeout
-
timeZone
@Nullable public java.lang.String timeZone()Time-zone in ISO 8601 used for executing the query on the server. More information available here.API name:
time_zone
-
fieldMultiValueLeniency
@Nullable public java.lang.Boolean 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
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupQueryRequestDeserializer
protected static void setupQueryRequestDeserializer(DelegatingDeserializer<QueryRequest.Builder> op)
-