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

_transport, _transportOptions, getDeserializer

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 java.util.concurrent.CompletableFuture<DeleteAsyncSearchResponse> delete(DeleteAsyncSearchRequest request)
                                                                         throws java.io.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:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

delete

public final java.util.concurrent.CompletableFuture<DeleteAsyncSearchResponse> delete(java.util.function.Function<DeleteAsyncSearchRequest.Builder,ObjectBuilder<DeleteAsyncSearchRequest>> fn)
                                                                               throws java.io.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:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

get

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

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

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

get

public final <TDocument>
java.util.concurrent.CompletableFuture<GetAsyncSearchResponse<TDocument>> get(java.util.function.Function<GetAsyncSearchRequest.Builder,ObjectBuilder<GetAsyncSearchRequest>> fn,
java.lang.Class<TDocument> tDocumentClass)
                                                                       throws java.io.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:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

status

public <TDocument>
java.util.concurrent.CompletableFuture<AsyncSearchStatusResponse<TDocument>> status(AsyncSearchStatusRequest request,
java.lang.Class<TDocument> tDocumentClass)
                                                                             throws java.io.IOException,
ElasticsearchException

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

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

status

public final <TDocument>
java.util.concurrent.CompletableFuture<AsyncSearchStatusResponse<TDocument>> status(java.util.function.Function<AsyncSearchStatusRequest.Builder,ObjectBuilder<AsyncSearchStatusRequest>> fn,
java.lang.Class<TDocument> tDocumentClass)
                                                                             throws java.io.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:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

submit

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

Executes a search request asynchronously.

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

submit

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

Executes a search request asynchronously.

Parameters:

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

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co