Package co.elastic.clients.elasticsearch.async_search

Class GetAsyncSearchRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.async_search.GetAsyncSearchRequest
public class GetAsyncSearchRequest extends RequestBase
Get async search results.

Retrieve the results of a previously submitted asynchronous search request. If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.

See Also:

  • Field Details

  • Method Details

    • of

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

    • id

      public final String id()
      Required - A unique identifier for the async search.

      API name: id

    • keepAlive

      @Nullable public final Time keepAlive()
      The length of time that the async search should be available in the cluster. When not specified, the keep_alive set with the corresponding submit async request will be used. Otherwise, it is possible to override the value and extend the validity of the request. When this period expires, the search, if still running, is cancelled. If the search is completed, its saved results are deleted.

      API name: keep_alive

    • returnIntermediateResults

      @Nullable public final Boolean returnIntermediateResults()
      Specifies whether the response should contain intermediate results if the query is still running when the wait_for_completion_timeout expires or if no wait_for_completion_timeout is specified. If true and the search is still running, the search response will include any hits and partial aggregations that are available. If false and the search is still running, the search response will not include any hits (but possibly include total hits) nor will include any partial aggregations. When not specified, the intermediate results are returned for running queries.

      API name: return_intermediate_results

    • waitForCompletionTimeout

      @Nullable public final Time waitForCompletionTimeout()
      Specifies to wait for the search to be completed up until the provided timeout. Final results will be returned if available before the timeout expires, otherwise the currently available results will be returned once the timeout expires. By default no timeout is set meaning that the currently available results will be returned without any additional wait.

      API name: wait_for_completion_timeout

    • rebuild

      public GetAsyncSearchRequest.Builder rebuild()
      Returns:
      New GetAsyncSearchRequest.Builder initialized with field values of this instance

    • createGetEndpoint

      public static <TDocument> Endpoint<GetAsyncSearchRequest,GetAsyncSearchResponse<TDocument>,ErrorResponse> createGetEndpoint(JsonpDeserializer<TDocument> tDocumentDeserializer)
      Create an "async_search.get" endpoint.