Package co.elastic.clients.elasticsearch.async_search

Class AsyncSearchResponseBase

java.lang.Object
co.elastic.clients.elasticsearch.async_search.AsyncSearchResponseBase
All Implemented Interfaces:
JsonpSerializable
Direct Known Subclasses:
AsyncSearchDocumentResponseBase, StatusResponseBase
public abstract class AsyncSearchResponseBase extends Object implements JsonpSerializable
See Also:

  • Constructor Details

  • Method Details

    • id

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

    • isPartial

      public final boolean isPartial()
      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 boolean isRunning()
      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

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

      API name: expiration_time

    • expirationTimeInMillis

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

    • startTime

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

    • startTimeInMillis

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

    • completionTime

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

      API name: completion_time

    • completionTimeInMillis

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

    • 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

    • setupAsyncSearchResponseBaseDeserializer

      protected static <BuilderT extends AsyncSearchResponseBase.AbstractBuilder<BuilderT>> void setupAsyncSearchResponseBaseDeserializer(ObjectDeserializer<BuilderT> op)