Package co.elastic.clients.elasticsearch.sql

Class GetAsyncResponse.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<GetAsyncResponse.Builder>
co.elastic.clients.elasticsearch.sql.GetAsyncResponse.Builder
All Implemented Interfaces:
WithJson<GetAsyncResponse.Builder>, ObjectBuilder<GetAsyncResponse>
Enclosing class:
GetAsyncResponse
public static class GetAsyncResponse.Builder
extends WithJsonObjectBuilderBase<GetAsyncResponse.Builder>
implements ObjectBuilder<GetAsyncResponse>
Builder for GetAsyncResponse.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • id

      public final GetAsyncResponse.Builder id​(java.lang.String value)
      Required - 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

      public final GetAsyncResponse.Builder isRunning​(boolean value)
      Required - 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

      public final GetAsyncResponse.Builder isPartial​(boolean value)
      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 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 GetAsyncResponse.Builder columns​(java.util.List<Column> list)
      Column headings for the search results. Each object is a column.

      API name: columns

      Adds all elements of list to columns.

    • columns

      public final GetAsyncResponse.Builder columns​(Column value, Column... values)
      Column headings for the search results. Each object is a column.

      API name: columns

      Adds one or more values to columns.

    • columns

      public final GetAsyncResponse.Builder columns​(java.util.function.Function<Column.Builder,​ObjectBuilder<Column>> fn)
      Column headings for the search results. Each object is a column.

      API name: columns

      Adds a value to columns using a builder lambda.

    • cursor

      public final GetAsyncResponse.Builder cursor​(@Nullable java.lang.String value)
      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 GetAsyncResponse.Builder rows​(java.util.List<java.util.List<JsonData>> list)
      Required - Values for the search results.

      API name: rows

      Adds all elements of list to rows.

    • rows

      public final GetAsyncResponse.Builder rows​(java.util.List<JsonData> value, java.util.List<JsonData>... values)
      Required - Values for the search results.

      API name: rows

      Adds one or more values to rows.

    • self

      protected GetAsyncResponse.Builder self()
      Specified by:
      self in class WithJsonObjectBuilderBase<GetAsyncResponse.Builder>

    • build

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