Package co.elastic.clients.elasticsearch.async_search

Class ElasticsearchAsyncSearchClient

java.lang.Object

co.elastic.clients.ApiClient<ElasticsearchTransport,ElasticsearchAsyncSearchClient>

co.elastic.clients.elasticsearch.async_search.ElasticsearchAsyncSearchClient

public class ElasticsearchAsyncSearchClient
extends ApiClient<ElasticsearchTransport,ElasticsearchAsyncSearchClient>

Client for the async_search namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
ElasticsearchAsyncSearchClient(ElasticsearchTransport transport)
ElasticsearchAsyncSearchClient(ElasticsearchTransport transport, TransportOptions transportOptions)

Method Summary

Modifier and Type	Method	Description
DeleteAsyncSearchResponse	delete(DeleteAsyncSearchRequest request)	Deletes an async search by ID.
final DeleteAsyncSearchResponse	delete(Function<DeleteAsyncSearchRequest.Builder,ObjectBuilder<DeleteAsyncSearchRequest>> fn)	Deletes an async search by ID.
<TDocument> GetAsyncSearchResponse<TDocument>	get(GetAsyncSearchRequest request, Class<TDocument> tDocumentClass)	Retrieves the results of a previously submitted async search request given its ID.
final <TDocument> GetAsyncSearchResponse<TDocument>	get(Function<GetAsyncSearchRequest.Builder,ObjectBuilder<GetAsyncSearchRequest>> fn, Class<TDocument> tDocumentClass)	Retrieves the results of a previously submitted async search request given its ID.
AsyncSearchStatusResponse	status(AsyncSearchStatusRequest request)	Retrieves the status of a previously submitted async search request given its ID.
final AsyncSearchStatusResponse	status(Function<AsyncSearchStatusRequest.Builder,ObjectBuilder<AsyncSearchStatusRequest>> fn)	Retrieves the status of a previously submitted async search request given its ID.
<TDocument> SubmitResponse<TDocument>	submit(SubmitRequest request, Class<TDocument> tDocumentClass)	Executes a search request asynchronously.
final <TDocument> SubmitResponse<TDocument>	submit(Function<SubmitRequest.Builder,ObjectBuilder<SubmitRequest>> fn, Class<TDocument> tDocumentClass)	Executes a search request asynchronously.
ElasticsearchAsyncSearchClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class co.elastic.clients.ApiClient

_jsonpMapper, _transport, _transportOptions, getDeserializer, withTransportOptions

Methods inherited from class java.lang.Object

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

Constructor Details

ElasticsearchAsyncSearchClient

public ElasticsearchAsyncSearchClient(ElasticsearchTransport transport)

ElasticsearchAsyncSearchClient

public ElasticsearchAsyncSearchClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchAsyncSearchClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchAsyncSearchClient>

delete

public DeleteAsyncSearchResponse delete(DeleteAsyncSearchRequest request)
                                 throws IOException,
ElasticsearchException

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:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

delete

public final DeleteAsyncSearchResponse delete(Function<DeleteAsyncSearchRequest.Builder,ObjectBuilder<DeleteAsyncSearchRequest>> fn)
                                       throws IOException,
ElasticsearchException

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 builder to create the DeleteAsyncSearchRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

get

public <TDocument>
GetAsyncSearchResponse<TDocument> get(GetAsyncSearchRequest request,
 Class<TDocument> tDocumentClass)
                               throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

get

public final <TDocument>
GetAsyncSearchResponse<TDocument> get(Function<GetAsyncSearchRequest.Builder,ObjectBuilder<GetAsyncSearchRequest>> fn,
 Class<TDocument> tDocumentClass)
                               throws IOException,
ElasticsearchException

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

Parameters:

fn - a function that initializes a builder to create the GetAsyncSearchRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

status

public AsyncSearchStatusResponse status(AsyncSearchStatusRequest request)
                                 throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

status

public final AsyncSearchStatusResponse status(Function<AsyncSearchStatusRequest.Builder,ObjectBuilder<AsyncSearchStatusRequest>> fn)
                                       throws IOException,
ElasticsearchException

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

Parameters:

fn - a function that initializes a builder to create the AsyncSearchStatusRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

submit

public <TDocument> SubmitResponse<TDocument> submit(SubmitRequest request,
 Class<TDocument> tDocumentClass)
                                             throws IOException,
ElasticsearchException

Executes a search request asynchronously.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

submit

public final <TDocument> SubmitResponse<TDocument> submit(Function<SubmitRequest.Builder,ObjectBuilder<SubmitRequest>> fn,
 Class<TDocument> tDocumentClass)
                                                   throws IOException,
ElasticsearchException

Executes a search request asynchronously.

Parameters:

fn - a function that initializes a builder to create the SubmitRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co