Package co.elastic.clients.elasticsearch.sql

Class QueryResponse

java.lang.Object
co.elastic.clients.elasticsearch.sql.QueryResponse
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class QueryResponse
extends java.lang.Object
implements JsonpSerializable
See Also:
API specification

  • Field Details

  • Method Details

    • of

      public static QueryResponse of​(java.util.function.Function<QueryResponse.Builder,​ObjectBuilder<QueryResponse>> fn)

    • id

      @Nullable public final java.lang.String id()
      Identifier for the search. This value is only returned for async and saved synchronous searches. For CSV, TSV, and TXT responses, this value is returned in the Async-ID HTTP header.

      API name: id

    • isRunning

      @Nullable public final java.lang.Boolean isRunning()
      If true, the search is still running. If false, the search has finished. This value is only returned for async and saved synchronous searches. For CSV, TSV, and TXT responses, this value is returned in the Async-partial HTTP header.

      API name: is_running

    • isPartial

      @Nullable public final java.lang.Boolean isPartial()
      If true, the response does not contain complete search results. If is_partial is true and is_running is true, the search is still running. If is_partial is true but is_running is false, the results are partial due to a failure or timeout. This value is only returned for async and saved synchronous searches. For CSV, TSV, and TXT responses, this value is returned in the Async-partial HTTP header.

      API name: is_partial

    • columns

      public final java.util.List<Column> columns()
      Column headings for the search results. Each object is a column.

      API name: columns

    • cursor

      @Nullable public final java.lang.String cursor()
      Cursor for the next set of paginated results. For CSV, TSV, and TXT responses, this value is returned in the Cursor HTTP header.

      API name: cursor

    • rows

      public final java.util.List<java.util.List<JsonData>> rows()
      Required - Values for the search results.

      API name: rows

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

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object

    • setupQueryResponseDeserializer

      protected static void setupQueryResponseDeserializer​(ObjectDeserializer<QueryResponse.Builder> op)