Package co.elastic.clients.elasticsearch.async_search

Class AsyncSearchResponseBase.AbstractBuilder<BuilderT extends AsyncSearchResponseBase.AbstractBuilder<BuilderT>>

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch.async_search.AsyncSearchResponseBase.AbstractBuilder<BuilderT>
All Implemented Interfaces:
WithJson<BuilderT>
Direct Known Subclasses:
AsyncSearchDocumentResponseBase.AbstractBuilder, StatusResponseBase.AbstractBuilder
Enclosing class:
AsyncSearchResponseBase
public abstract static class AsyncSearchResponseBase.AbstractBuilder<BuilderT extends AsyncSearchResponseBase.AbstractBuilder<BuilderT>> extends WithJsonObjectBuilderBase<BuilderT>

  • Constructor Details

    • AbstractBuilder

      public AbstractBuilder()

  • Method Details

    • id

      public final BuilderT id(@Nullable String value)
      API name: id

    • isPartial

      public final BuilderT isPartial(boolean value)
      Required - When the query is no longer running, this property indicates whether the search failed or was successfully completed on all shards. While the query is running, is_partial is always set to true.

      API name: is_partial

    • isRunning

      public final BuilderT isRunning(boolean value)
      Required - Indicates whether the search is still running or has completed.

      info If the search failed after some shards returned their results or the node that is coordinating the async search dies, results may be partial even though is_running is false.

      API name: is_running

    • expirationTime

      public final BuilderT expirationTime(@Nullable DateTime value)
      Indicates when the async search will expire.

      API name: expiration_time

    • expirationTimeInMillis

      public final BuilderT expirationTimeInMillis(long value)
      Required - API name: expiration_time_in_millis

    • startTime

      public final BuilderT startTime(@Nullable DateTime value)
      API name: start_time

    • startTimeInMillis

      public final BuilderT startTimeInMillis(long value)
      Required - API name: start_time_in_millis

    • completionTime

      public final BuilderT completionTime(@Nullable DateTime value)
      Indicates when the async search completed. It is present only when the search has completed.

      API name: completion_time

    • completionTimeInMillis

      public final BuilderT completionTimeInMillis(@Nullable Long value)
      API name: completion_time_in_millis

    • self

      protected abstract BuilderT self()
      Specified by:
      self in class WithJsonObjectBuilderBase<BuilderT extends AsyncSearchResponseBase.AbstractBuilder<BuilderT>>