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.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
CompletableFuture<DeleteAsyncSearchResponse>	delete(DeleteAsyncSearchRequest request)	Deletes an async search by ID.
final CompletableFuture<DeleteAsyncSearchResponse>	delete(Function<DeleteAsyncSearchRequest.Builder,ObjectBuilder<DeleteAsyncSearchRequest>> fn)	Deletes an async search by ID.
<TDocument> CompletableFuture<GetAsyncSearchResponse<TDocument>>	get(GetAsyncSearchRequest request, Class<TDocument> tDocumentClass)	Retrieves the results of a previously submitted async search request given its ID.
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 ID.
CompletableFuture<AsyncSearchStatusResponse>	status(AsyncSearchStatusRequest request)	Retrieves the status of a previously submitted async search request given its ID.
final CompletableFuture<AsyncSearchStatusResponse>	status(Function<AsyncSearchStatusRequest.Builder,ObjectBuilder<AsyncSearchStatusRequest>> fn)	Retrieves the status of a previously submitted async search request given its ID.
<TDocument> CompletableFuture<SubmitResponse<TDocument>>	submit(SubmitRequest request, Class<TDocument> tDocumentClass)	Executes a search request asynchronously.
final <TDocument> CompletableFuture<SubmitResponse<TDocument>>	submit(Function<SubmitRequest.Builder,ObjectBuilder<SubmitRequest>> fn, Class<TDocument> tDocumentClass)	Executes a search request asynchronously.
ElasticsearchAsyncSearchAsyncClient	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

ElasticsearchAsyncSearchAsyncClient

public ElasticsearchAsyncSearchAsyncClient(ElasticsearchTransport transport)

ElasticsearchAsyncSearchAsyncClient

public ElasticsearchAsyncSearchAsyncClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

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 ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted.

See Also:

• Documentation on elastic.co

delete

public final CompletableFuture<DeleteAsyncSearchResponse> delete(Function<DeleteAsyncSearchRequest.Builder,ObjectBuilder<DeleteAsyncSearchRequest>> fn)

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

See Also:

• Documentation on elastic.co

get

public <TDocument>
CompletableFuture<GetAsyncSearchResponse<TDocument>> get(GetAsyncSearchRequest request,
 Class<TDocument> tDocumentClass)

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

See Also:

• Documentation on elastic.co

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 ID.

Parameters:

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

See Also:

• Documentation on elastic.co

status

public CompletableFuture<AsyncSearchStatusResponse> status(AsyncSearchStatusRequest request)

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

See Also:

• Documentation on elastic.co

status

public final CompletableFuture<AsyncSearchStatusResponse> status(Function<AsyncSearchStatusRequest.Builder,ObjectBuilder<AsyncSearchStatusRequest>> fn)

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

See Also:

• Documentation on elastic.co

submit

public <TDocument>
CompletableFuture<SubmitResponse<TDocument>> submit(SubmitRequest request,
 Class<TDocument> tDocumentClass)

Executes a search request asynchronously.

See Also:

• Documentation on elastic.co

submit

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

Executes a search request asynchronously.

Parameters:

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

See Also:

• Documentation on elastic.co