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

All Implemented Interfaces:

Closeable, AutoCloseable

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)	Delete an async search.
final CompletableFuture<DeleteAsyncSearchResponse>	delete(Function<DeleteAsyncSearchRequest.Builder,ObjectBuilder<DeleteAsyncSearchRequest>> fn)	Delete an async search.
CompletableFuture<GetAsyncSearchResponse<Void>>	get(GetAsyncSearchRequest request)	Overload of get(GetAsyncSearchRequest, Class), where Class is defined as Void, meaning the documents will not be deserialized.
<TDocument> CompletableFuture<GetAsyncSearchResponse<TDocument>>	get(GetAsyncSearchRequest request, Class<TDocument> tDocumentClass)	Get async search results.
<TDocument> CompletableFuture<GetAsyncSearchResponse<TDocument>>	get(GetAsyncSearchRequest request, Type tDocumentType)	Get async search results.
final CompletableFuture<GetAsyncSearchResponse<Void>>	get(Function<GetAsyncSearchRequest.Builder,ObjectBuilder<GetAsyncSearchRequest>> fn)	Overload of get(Function, Class), where Class is defined as Void, meaning the documents will not be deserialized.
final <TDocument> CompletableFuture<GetAsyncSearchResponse<TDocument>>	get(Function<GetAsyncSearchRequest.Builder,ObjectBuilder<GetAsyncSearchRequest>> fn, Class<TDocument> tDocumentClass)	Get async search results.
final <TDocument> CompletableFuture<GetAsyncSearchResponse<TDocument>>	get(Function<GetAsyncSearchRequest.Builder,ObjectBuilder<GetAsyncSearchRequest>> fn, Type tDocumentType)	Get async search results.
CompletableFuture<AsyncSearchStatusResponse>	status(AsyncSearchStatusRequest request)	Get the async search status.
final CompletableFuture<AsyncSearchStatusResponse>	status(Function<AsyncSearchStatusRequest.Builder,ObjectBuilder<AsyncSearchStatusRequest>> fn)	Get the async search status.
CompletableFuture<SubmitResponse<Void>>	submit(SubmitRequest request)	Overload of submit(SubmitRequest, Class), where Class is defined as Void, meaning the documents will not be deserialized.
<TDocument> CompletableFuture<SubmitResponse<TDocument>>	submit(SubmitRequest request, Class<TDocument> tDocumentClass)	Run an async search.
<TDocument> CompletableFuture<SubmitResponse<TDocument>>	submit(SubmitRequest request, Type tDocumentType)	Run an async search.
final CompletableFuture<SubmitResponse<Void>>	submit(Function<SubmitRequest.Builder,ObjectBuilder<SubmitRequest>> fn)	Overload of submit(Function, Class), where Class is defined as Void, meaning the documents will not be deserialized.
final <TDocument> CompletableFuture<SubmitResponse<TDocument>>	submit(Function<SubmitRequest.Builder,ObjectBuilder<SubmitRequest>> fn, Class<TDocument> tDocumentClass)	Run an async search.
final <TDocument> CompletableFuture<SubmitResponse<TDocument>>	submit(Function<SubmitRequest.Builder,ObjectBuilder<SubmitRequest>> fn, Type tDocumentType)	Run an async search.
ElasticsearchAsyncSearchAsyncClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class co.elastic.clients.ApiClient

_jsonpMapper, _transport, _transportOptions, close, 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)

Delete an async search.

If the asynchronous search is still running, it is 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:

• Documentation on elastic.co

delete

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

Delete an async search.

If the asynchronous search is still running, it is 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:

• Documentation on elastic.co

get

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

Get async search results.

Retrieve the results of a previously submitted asynchronous search request. 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:

• Documentation on elastic.co

get

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

Get async search results.

Retrieve the results of a previously submitted asynchronous search request. 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:

• Documentation on elastic.co

get

public CompletableFuture<GetAsyncSearchResponse<Void>> get(GetAsyncSearchRequest request)

Overload of get(GetAsyncSearchRequest, Class), where Class is defined as Void, meaning the documents will not be deserialized.

get

public final CompletableFuture<GetAsyncSearchResponse<Void>> get(Function<GetAsyncSearchRequest.Builder,ObjectBuilder<GetAsyncSearchRequest>> fn)

Overload of get(Function, Class), where Class is defined as Void, meaning the documents will not be deserialized.

get

public <TDocument>
CompletableFuture<GetAsyncSearchResponse<TDocument>> get(GetAsyncSearchRequest request,
 Type tDocumentType)

Get async search results.

Retrieve the results of a previously submitted asynchronous search request. 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:

• Documentation on elastic.co

get

public final <TDocument>
CompletableFuture<GetAsyncSearchResponse<TDocument>> get(Function<GetAsyncSearchRequest.Builder,ObjectBuilder<GetAsyncSearchRequest>> fn,
 Type tDocumentType)

Get async search results.

Retrieve the results of a previously submitted asynchronous search request. 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:

• Documentation on elastic.co

status

public CompletableFuture<AsyncSearchStatusResponse> status(AsyncSearchStatusRequest request)

Get the async search status.

Get the status of a previously submitted async search request given its identifier, without retrieving search results. If the Elasticsearch security features are enabled, the access to the status of a specific async search is restricted to:

• The user or API key that submitted the original async search request.
• Users that have the monitor cluster privilege or greater privileges.

See Also:

• Documentation on elastic.co

status

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

Get the async search status.

Get the status of a previously submitted async search request given its identifier, without retrieving search results. If the Elasticsearch security features are enabled, the access to the status of a specific async search is restricted to:

• The user or API key that submitted the original async search request.
• Users that have the monitor cluster privilege or greater privileges.

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)

Run an async search.

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. Partial results become available following the sort criteria that was requested.

Warning: Asynchronous search does not support scroll or search requests that include only the suggest section.

By default, Elasticsearch does not 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:

• Documentation on elastic.co

submit

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

Run an async search.

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. Partial results become available following the sort criteria that was requested.

Warning: Asynchronous search does not support scroll or search requests that include only the suggest section.

By default, Elasticsearch does not 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:

• Documentation on elastic.co

submit

public CompletableFuture<SubmitResponse<Void>> submit(SubmitRequest request)

Overload of submit(SubmitRequest, Class), where Class is defined as Void, meaning the documents will not be deserialized.

submit

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

Overload of submit(Function, Class), where Class is defined as Void, meaning the documents will not be deserialized.

submit

public <TDocument>
CompletableFuture<SubmitResponse<TDocument>> submit(SubmitRequest request,
 Type tDocumentType)

Run an async search.

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. Partial results become available following the sort criteria that was requested.

Warning: Asynchronous search does not support scroll or search requests that include only the suggest section.

By default, Elasticsearch does not 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:

• Documentation on elastic.co

submit

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

Run an async search.

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. Partial results become available following the sort criteria that was requested.

Warning: Asynchronous search does not support scroll or search requests that include only the suggest section.

By default, Elasticsearch does not 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:

• Documentation on elastic.co