Package co.elastic.clients.elasticsearch.sql

Class GetAsyncStatusResponse.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • id

      public final GetAsyncStatusResponse.Builder id​(java.lang.String value)
      Required - Identifier for the search.

      API name: id

    • isRunning

      public final GetAsyncStatusResponse.Builder isRunning​(boolean value)
      Required - If true, the search is still running. If false, the search has finished.

      API name: is_running

    • isPartial

      public final GetAsyncStatusResponse.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.

      API name: is_partial

    • startTimeInMillis

      public final GetAsyncStatusResponse.Builder startTimeInMillis​(long value)
      Required - Timestamp, in milliseconds since the Unix epoch, when the search started. The API only returns this property for running searches.

      API name: start_time_in_millis

    • expirationTimeInMillis

      public final GetAsyncStatusResponse.Builder expirationTimeInMillis​(long value)
      Required - Timestamp, in milliseconds since the Unix epoch, when Elasticsearch will delete the search and its results, even if the search is still running.

      API name: expiration_time_in_millis

    • completionStatus

      public final GetAsyncStatusResponse.Builder completionStatus​(@Nullable java.lang.Number value)
      HTTP status code for the search. The API only returns this property for completed searches.

      API name: completion_status

    • self

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

    • build

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