Package co.elastic.clients.elasticsearch.async_search

Class ElasticsearchAsyncSearchAsyncClient

java.lang.Object
co.elastic.clients.ApiClient<ElasticsearchTransport,ElasticsearchAsyncSearchAsyncClient>
co.elastic.clients.elasticsearch.async_search.ElasticsearchAsyncSearchAsyncClient
public class ElasticsearchAsyncSearchAsyncClient extends ApiClient<ElasticsearchTransport,ElasticsearchAsyncSearchAsyncClient>
Client for the async_search namespace.

  • Constructor Details

  • Method Details

    • withTransportOptions

      public ElasticsearchAsyncSearchAsyncClient withTransportOptions(@Nullable TransportOptions transportOptions)
      Description copied from class: ApiClient
      Creates a new client with some request options
      Specified by:
      withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchAsyncSearchAsyncClient>

    • delete

      public CompletableFuture<DeleteAsyncSearchResponse> delete(DeleteAsyncSearchRequest request)
      Deletes an async search by identifier. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted. If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege.
      See Also:

    • delete

      public final CompletableFuture<DeleteAsyncSearchResponse> delete(Function<DeleteAsyncSearchRequest.Builder,ObjectBuilder<DeleteAsyncSearchRequest>> fn)
      Deletes an async search by identifier. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted. If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege.
      Parameters:
      fn - a function that initializes a builder to create the DeleteAsyncSearchRequest
      See Also:

    • get

      public <TDocument> CompletableFuture<GetAsyncSearchResponse<TDocument>> get(GetAsyncSearchRequest request, Class<TDocument> tDocumentClass)
      Retrieves the results of a previously submitted async search request given its identifier. 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:

    • get

      public final <TDocument> CompletableFuture<GetAsyncSearchResponse<TDocument>> get(Function<GetAsyncSearchRequest.Builder,ObjectBuilder<GetAsyncSearchRequest>> fn, Class<TDocument> tDocumentClass)
      Retrieves the results of a previously submitted async search request given its identifier. 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.
      Parameters:
      fn - a function that initializes a builder to create the GetAsyncSearchRequest
      See Also:

    • get

      public <TDocument> CompletableFuture<GetAsyncSearchResponse<TDocument>> get(GetAsyncSearchRequest request, Type tDocumentType)
      Retrieves the results of a previously submitted async search request given its identifier. 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:

    • get

      public final <TDocument> CompletableFuture<GetAsyncSearchResponse<TDocument>> get(Function<GetAsyncSearchRequest.Builder,ObjectBuilder<GetAsyncSearchRequest>> fn, Type tDocumentType)
      Retrieves the results of a previously submitted async search request given its identifier. 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.
      Parameters:
      fn - a function that initializes a builder to create the GetAsyncSearchRequest
      See Also:

    • status

      public CompletableFuture<AsyncSearchStatusResponse> status(AsyncSearchStatusRequest request)
      Get async search status Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role.
      See Also:

    • status

      public final CompletableFuture<AsyncSearchStatusResponse> status(Function<AsyncSearchStatusRequest.Builder,ObjectBuilder<AsyncSearchStatusRequest>> fn)
      Get async search status Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role.
      Parameters:
      fn - a function that initializes a builder to create the AsyncSearchStatusRequest
      See Also:

    • submit

      public <TDocument> CompletableFuture<SubmitResponse<TDocument>> submit(SubmitRequest request, Class<TDocument> tDocumentClass)
      Runs a search request asynchronously. When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. Warning: Async search does not support scroll nor search requests that only include the suggest section. By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting.
      See Also:

    • submit

      public final <TDocument> CompletableFuture<SubmitResponse<TDocument>> submit(Function<SubmitRequest.Builder,ObjectBuilder<SubmitRequest>> fn, Class<TDocument> tDocumentClass)
      Runs a search request asynchronously. When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. Warning: Async search does not support scroll nor search requests that only include the suggest section. By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting.
      Parameters:
      fn - a function that initializes a builder to create the SubmitRequest
      See Also:

    • submit

      public <TDocument> CompletableFuture<SubmitResponse<TDocument>> submit(SubmitRequest request, Type tDocumentType)
      Runs a search request asynchronously. When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. Warning: Async search does not support scroll nor search requests that only include the suggest section. By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting.
      See Also:

    • submit

      public final <TDocument> CompletableFuture<SubmitResponse<TDocument>> submit(Function<SubmitRequest.Builder,ObjectBuilder<SubmitRequest>> fn, Type tDocumentType)
      Runs a search request asynchronously. When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. Warning: Async search does not support scroll nor search requests that only include the suggest section. By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting.
      Parameters:
      fn - a function that initializes a builder to create the SubmitRequest
      See Also: