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 identifier.
final DeleteAsyncSearchResponse	delete(Function<DeleteAsyncSearchRequest.Builder,ObjectBuilder<DeleteAsyncSearchRequest>> fn)	Deletes an async search by identifier.
<TDocument> GetAsyncSearchResponse<TDocument>	get(GetAsyncSearchRequest request, Class<TDocument> tDocumentClass)	Retrieves the results of a previously submitted async search request given its identifier.
<TDocument> GetAsyncSearchResponse<TDocument>	get(GetAsyncSearchRequest request, Type tDocumentType)	Retrieves the results of a previously submitted async search request given its identifier.
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 identifier.
final <TDocument> GetAsyncSearchResponse<TDocument>	get(Function<GetAsyncSearchRequest.Builder,ObjectBuilder<GetAsyncSearchRequest>> fn, Type tDocumentType)	Retrieves the results of a previously submitted async search request given its identifier.
AsyncSearchStatusResponse	status(AsyncSearchStatusRequest request)	Get async search status Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.
final AsyncSearchStatusResponse	status(Function<AsyncSearchStatusRequest.Builder,ObjectBuilder<AsyncSearchStatusRequest>> fn)	Get async search status Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.
<TDocument> SubmitResponse<TDocument>	submit(SubmitRequest request, Class<TDocument> tDocumentClass)	Runs a search request asynchronously.
<TDocument> SubmitResponse<TDocument>	submit(SubmitRequest request, Type tDocumentType)	Runs a search request asynchronously.
final <TDocument> SubmitResponse<TDocument>	submit(Function<SubmitRequest.Builder,ObjectBuilder<SubmitRequest>> fn, Class<TDocument> tDocumentClass)	Runs a search request asynchronously.
final <TDocument> SubmitResponse<TDocument>	submit(Function<SubmitRequest.Builder,ObjectBuilder<SubmitRequest>> fn, Type tDocumentType)	Runs 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 identifier. If the search is still running, the search request will be 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

Deletes an async search by identifier. If the search is still running, the search request will be 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

Retrieves the results of a previously submitted async search request given its identifier. 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

Retrieves the results of a previously submitted async search request given its identifier. 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 <TDocument>
GetAsyncSearchResponse<TDocument> get(GetAsyncSearchRequest request,
 Type tDocumentType)
                               throws IOException,
ElasticsearchException

Retrieves the results of a previously submitted async search request given its identifier. 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

Retrieves the results of a previously submitted async search request given its identifier. 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 async search status Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

status

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

Get async search status Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role.

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

Runs a search request asynchronously. 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, hence partial results become available following the sort criteria that was requested. Warning: Async search does not support scroll nor search requests that only include the suggest section. By default, Elasticsearch doesn’t 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

Runs a search request asynchronously. 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, hence partial results become available following the sort criteria that was requested. Warning: Async search does not support scroll nor search requests that only include the suggest section. By default, Elasticsearch doesn’t 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 <TDocument> SubmitResponse<TDocument> submit(SubmitRequest request,
 Type tDocumentType)
                                             throws IOException,
ElasticsearchException

Runs a search request asynchronously. 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, hence partial results become available following the sort criteria that was requested. Warning: Async search does not support scroll nor search requests that only include the suggest section. By default, Elasticsearch doesn’t 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

Runs a search request asynchronously. 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, hence partial results become available following the sort criteria that was requested. Warning: Async search does not support scroll nor search requests that only include the suggest section. By default, Elasticsearch doesn’t 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