Package co.elastic.clients.elasticsearch.esql

Class QueryRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.esql.QueryRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class QueryRequest extends RequestBase implements JsonpSerializable
Executes an ES|QL request
See Also:

  • Field Details

  • Method Details

    • of

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

    • columnar

      @Nullable public final Boolean columnar()
      By default, ES|QL returns results as rows. For example, FROM returns each individual document as one row. For the JSON, YAML, CBOR and smile formats, ES|QL can return the results in a columnar fashion where one row represents all the values of a certain column in the results.

      API name: columnar

    • delimiter

      @Nullable public final String delimiter()
      The character to use between values within a CSV row. Only valid for the CSV format.

      API name: delimiter

    • filter

      @Nullable public final Query filter()
      Specify a Query DSL query in the filter parameter to filter the set of documents that an ES|QL query runs on.

      API name: filter

    • format

      @Nullable public final String format()
      A short version of the Accept header, e.g. json, yaml.

      API name: format

    • locale

      @Nullable public final String locale()
      API name: locale

    • params

      public final List<FieldValue> params()
      To avoid any attempts of hacking or code injection, extract the values in a separate list of parameters. Use question mark placeholders (?) in the query string for each of the parameters.

      API name: params

    • query

      public final String query()
      Required - The ES|QL query API accepts an ES|QL query string in the query parameter, runs it, and returns the results.

      API name: query

    • 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)

    • setupQueryRequestDeserializer

      protected static void setupQueryRequestDeserializer(ObjectDeserializer<QueryRequest.Builder> op)