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

All Implemented Interfaces:

Closeable, AutoCloseable

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

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

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

delete

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

get

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

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.

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

get

public GetAsyncSearchResponse<Void> get(GetAsyncSearchRequest request)
                                 throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

get

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

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

Throws:

IOException

ElasticsearchException

get

public <TDocument>
GetAsyncSearchResponse<TDocument> get(GetAsyncSearchRequest request,
 Type tDocumentType)
                               throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

get

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

status

public AsyncSearchStatusResponse status(AsyncSearchStatusRequest request)
                                 throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

status

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

submit

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

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.

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

submit

public SubmitResponse<Void> submit(SubmitRequest request)
                            throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

submit

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

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

Throws:

IOException

ElasticsearchException

submit

public <TDocument> SubmitResponse<TDocument> submit(SubmitRequest request,
 Type tDocumentType)
                                             throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

submit

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co