TranslateRequest (java-client 7.17.5 API)

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

Translates SQL into Elasticsearch queries

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

Method Summary

Modifier and Type	Method	Description
`java.lang.Integer`	`fetchSize()`	API name: `fetch_size`
`Query`	`filter()`	API name: `filter`
`static TranslateRequest`	`of(java.util.function.Function<TranslateRequest.Builder,ObjectBuilder<TranslateRequest>> fn)`
`java.lang.String`	`query()`	Required - API name: `query`
`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)`
`java.lang.String`	`timeZone()`	API name: `time_zone`

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(java.util.function.Function<TranslateRequest.Builder,ObjectBuilder<TranslateRequest>> fn)
- fetchSize
  
  @Nullable public final java.lang.Integer fetchSize()
  
  API name: fetch_size
- filter
  
  @Nullable public final Query filter()
  
  API name: filter
- query
  
  public final java.lang.String query()
  
  Required - API name: query
- timeZone
  
  @Nullable public final java.lang.String timeZone()
  
  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)