Package co.elastic.clients.elasticsearch.sql

Class GetAsyncResponse

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

  • Field Details

  • Method Details

    • of

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

    • id

      public final String id()
      Required - Identifier for the search. This value is returned only 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

      public final boolean isRunning()
      Required - If true, the search is still running. If false, the search has finished. This value is returned only 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

      public final boolean isPartial()
      Required - 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 returned only 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 List<Column> columns()
      Column headings for the search results. Each object is a column.

      API name: columns

    • cursor

      @Nullable public final String cursor()
      The 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 List<List<JsonData>> rows()
      Required - The 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 String toString()
      Overrides:
      toString in class Object

    • setupGetAsyncResponseDeserializer

      protected static void setupGetAsyncResponseDeserializer(ObjectDeserializer<GetAsyncResponse.Builder> op)