Package co.elastic.clients.elasticsearch.sql

Class TranslateRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.sql.TranslateRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class TranslateRequest
extends RequestBase
implements JsonpSerializable

Translate SQL into Elasticsearch queries. Translate an SQL search into a search API request containing Query DSL. It accepts the same request body parameters as the SQL search API, excluding cursor.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TranslateRequest.Builder	Builder for TranslateRequest.

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 final JsonpDeserializer<TranslateRequest>	_DESERIALIZER	Json deserializer for TranslateRequest
static final Endpoint<TranslateRequest,TranslateResponse,ErrorResponse>	_ENDPOINT	Endpoint "sql.translate".

Method Summary

Modifier and Type	Method	Description
final Integer	fetchSize()	The maximum number of rows (or entries) to return in one response.
final Query	filter()	The Elasticsearch query DSL for additional filtering.
static TranslateRequest	of(Function<TranslateRequest.Builder,ObjectBuilder<TranslateRequest>> fn)
final String	query()	Required - The SQL query to run.
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	setupTranslateRequestDeserializer(ObjectDeserializer<TranslateRequest.Builder> op)
final String	timeZone()	The ISO-8601 time zone ID for the search.

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

public static final JsonpDeserializer<TranslateRequest> _DESERIALIZER

Json deserializer for TranslateRequest

_ENDPOINT

public static final Endpoint<TranslateRequest,TranslateResponse,ErrorResponse> _ENDPOINT

Endpoint "sql.translate".

Method Details

of

public static TranslateRequest of(Function<TranslateRequest.Builder,ObjectBuilder<TranslateRequest>> fn)

fetchSize

@Nullable
public final Integer fetchSize()

The maximum number of rows (or entries) to return in one response.

API name: fetch_size

filter

@Nullable
public final Query filter()

The Elasticsearch query DSL for additional filtering.

API name: filter

query

public final String query()

Required - The SQL query to run.

API name: query

timeZone

@Nullable
public final String timeZone()

The ISO-8601 time zone ID for the search.

API name: time_zone

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

setupTranslateRequestDeserializer

protected static void setupTranslateRequestDeserializer(ObjectDeserializer<TranslateRequest.Builder> op)