Package co.elastic.clients.elasticsearch.async_search

Class ElasticsearchAsyncSearchClient

java.lang.Object

co.elastic.clients.base.ApiClient

co.elastic.clients.elasticsearch.async_search.ElasticsearchAsyncSearchClient

public class ElasticsearchAsyncSearchClient
extends ApiClient

Client for the async_search namespace.

Field Summary

Fields inherited from class co.elastic.clients.base.ApiClient

transport

Constructor Summary

Constructors

Constructor	Description
ElasticsearchAsyncSearchClient(Transport transport)

Method Summary

Modifier and Type	Method	Description
DeleteAsyncSearchResponse	delete(DeleteAsyncSearchRequest request)	Deletes an async search by ID.
DeleteAsyncSearchResponse	delete(java.util.function.Function<DeleteAsyncSearchRequest.Builder,ObjectBuilder<DeleteAsyncSearchRequest>> fn)	Deletes an async search by ID.
<TDocument> GetAsyncSearchResponse<TDocument>	get(GetAsyncSearchRequest request, java.lang.Class<TDocument> tDocumentClass)	Retrieves the results of a previously submitted async search request given its ID.
<TDocument> GetAsyncSearchResponse<TDocument>	get(java.util.function.Function<GetAsyncSearchRequest.Builder,ObjectBuilder<GetAsyncSearchRequest>> fn, java.lang.Class<TDocument> tDocumentClass)	Retrieves the results of a previously submitted async search request given its ID.
<TDocument> StatusResponse<TDocument>	status(StatusRequest request, java.lang.Class<TDocument> tDocumentClass)	Retrieves the status of a previously submitted async search request given its ID.
<TDocument> StatusResponse<TDocument>	status(java.util.function.Function<StatusRequest.Builder,ObjectBuilder<StatusRequest>> fn, java.lang.Class<TDocument> tDocumentClass)	Retrieves the status of a previously submitted async search request given its ID.
<TDocument> SubmitResponse<TDocument>	submit(SubmitRequest request, java.lang.Class<TDocument> tDocumentClass)	Executes a search request asynchronously.
<TDocument> SubmitResponse<TDocument>	submit(java.util.function.Function<SubmitRequest.Builder,ObjectBuilder<SubmitRequest>> fn, java.lang.Class<TDocument> tDocumentClass)	Executes a search request asynchronously.

Methods inherited from class co.elastic.clients.base.ApiClient

_transport, getDeserializer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ElasticsearchAsyncSearchClient

public ElasticsearchAsyncSearchClient(Transport transport)

Method Details

delete

public DeleteAsyncSearchResponse delete(DeleteAsyncSearchRequest request)
                                 throws java.io.IOException

Deletes an async search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

delete

public final DeleteAsyncSearchResponse delete(java.util.function.Function<DeleteAsyncSearchRequest.Builder,ObjectBuilder<DeleteAsyncSearchRequest>> fn)
                                       throws java.io.IOException

Deletes an async search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

get

public <TDocument>
GetAsyncSearchResponse<TDocument> get(GetAsyncSearchRequest request,
java.lang.Class<TDocument> tDocumentClass)
                               throws java.io.IOException

Retrieves the results of a previously submitted async search request given its ID.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

get

public final <TDocument>
GetAsyncSearchResponse<TDocument> get(java.util.function.Function<GetAsyncSearchRequest.Builder,ObjectBuilder<GetAsyncSearchRequest>> fn,
java.lang.Class<TDocument> tDocumentClass)
                               throws java.io.IOException

Retrieves the results of a previously submitted async search request given its ID.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

status

public <TDocument> StatusResponse<TDocument> status(StatusRequest request,
java.lang.Class<TDocument> tDocumentClass)
                                             throws java.io.IOException

Retrieves the status of a previously submitted async search request given its ID.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

status

public final <TDocument> StatusResponse<TDocument> status(java.util.function.Function<StatusRequest.Builder,ObjectBuilder<StatusRequest>> fn,
java.lang.Class<TDocument> tDocumentClass)
                                                   throws java.io.IOException

Retrieves the status of a previously submitted async search request given its ID.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

submit

public <TDocument> SubmitResponse<TDocument> submit(SubmitRequest request,
java.lang.Class<TDocument> tDocumentClass)
                                             throws java.io.IOException

Executes a search request asynchronously.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

submit

public final <TDocument> SubmitResponse<TDocument> submit(java.util.function.Function<SubmitRequest.Builder,ObjectBuilder<SubmitRequest>> fn,
java.lang.Class<TDocument> tDocumentClass)
                                                   throws java.io.IOException

Executes a search request asynchronously.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co