Package co.elastic.clients.elasticsearch.sql

Class QueryRequest.Builder

java.lang.Object
co.elastic.clients.elasticsearch.sql.QueryRequest.Builder
All Implemented Interfaces:
ObjectBuilder<QueryRequest>
Enclosing class:
QueryRequest
public static class QueryRequest.Builder
extends java.lang.Object
implements ObjectBuilder<QueryRequest>
Builder for QueryRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • format

      public QueryRequest.Builder format​(@Nullable java.lang.String value)
      a short version of the Accept header, e.g. json, yaml

      API name: format

    • columnar

      public QueryRequest.Builder columnar​(@Nullable java.lang.Boolean value)
      API name: columnar

    • cursor

      public QueryRequest.Builder cursor​(@Nullable java.lang.String value)
      API name: cursor

    • fetchSize

      public QueryRequest.Builder fetchSize​(@Nullable java.lang.Integer value)
      The maximum number of rows (or entries) to return in one response

      API name: fetch_size

    • filter

      public QueryRequest.Builder filter​(@Nullable Query value)
      Optional Elasticsearch query DSL for additional filtering.

      API name: filter

    • filter

      public QueryRequest.Builder filter​(java.util.function.Function<Query.Builder,​ObjectBuilder<Query>> fn)
      Optional Elasticsearch query DSL for additional filtering.

      API name: filter

    • query

      public QueryRequest.Builder query​(@Nullable java.lang.String value)
      SQL query to execute

      API name: query

    • requestTimeout

      public QueryRequest.Builder requestTimeout​(@Nullable java.lang.String value)
      The timeout before the request fails.

      API name: request_timeout

    • pageTimeout

      public QueryRequest.Builder pageTimeout​(@Nullable java.lang.String value)
      The timeout before a pagination request fails.

      API name: page_timeout

    • timeZone

      public QueryRequest.Builder timeZone​(@Nullable java.lang.String value)
      Time-zone in ISO 8601 used for executing the query on the server. More information available here.

      API name: time_zone

    • fieldMultiValueLeniency

      public QueryRequest.Builder fieldMultiValueLeniency​(@Nullable 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).

      API name: field_multi_value_leniency

    • build

      public QueryRequest build()
      Builds a QueryRequest.
      Specified by:
      build in interface ObjectBuilder<QueryRequest>
      Throws:
      java.lang.NullPointerException - if some of the required fields are null.