Package co.elastic.clients.elasticsearch.sql

Class ElasticsearchSqlAsyncClient

java.lang.Object

co.elastic.clients.ApiClient<ElasticsearchTransport,ElasticsearchSqlAsyncClient>

co.elastic.clients.elasticsearch.sql.ElasticsearchSqlAsyncClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class ElasticsearchSqlAsyncClient
extends ApiClient<ElasticsearchTransport,ElasticsearchSqlAsyncClient>

Client for the sql namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
CompletableFuture<ClearCursorResponse>	clearCursor(ClearCursorRequest request)	Clear an SQL search cursor.
final CompletableFuture<ClearCursorResponse>	clearCursor(Function<ClearCursorRequest.Builder,ObjectBuilder<ClearCursorRequest>> fn)	Clear an SQL search cursor.
CompletableFuture<DeleteAsyncResponse>	deleteAsync(DeleteAsyncRequest request)	Delete an async SQL search.
final CompletableFuture<DeleteAsyncResponse>	deleteAsync(Function<DeleteAsyncRequest.Builder,ObjectBuilder<DeleteAsyncRequest>> fn)	Delete an async SQL search.
CompletableFuture<GetAsyncResponse>	getAsync(GetAsyncRequest request)	Get async SQL search results.
final CompletableFuture<GetAsyncResponse>	getAsync(Function<GetAsyncRequest.Builder,ObjectBuilder<GetAsyncRequest>> fn)	Get async SQL search results.
CompletableFuture<GetAsyncStatusResponse>	getAsyncStatus(GetAsyncStatusRequest request)	Get the async SQL search status.
final CompletableFuture<GetAsyncStatusResponse>	getAsyncStatus(Function<GetAsyncStatusRequest.Builder,ObjectBuilder<GetAsyncStatusRequest>> fn)	Get the async SQL search status.
CompletableFuture<QueryResponse>	query()	Get SQL search results.
CompletableFuture<QueryResponse>	query(QueryRequest request)	Get SQL search results.
final CompletableFuture<QueryResponse>	query(Function<QueryRequest.Builder,ObjectBuilder<QueryRequest>> fn)	Get SQL search results.
CompletableFuture<TranslateResponse>	translate(TranslateRequest request)	Translate SQL into Elasticsearch queries.
final CompletableFuture<TranslateResponse>	translate(Function<TranslateRequest.Builder,ObjectBuilder<TranslateRequest>> fn)	Translate SQL into Elasticsearch queries.
ElasticsearchSqlAsyncClient	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

ElasticsearchSqlAsyncClient

public ElasticsearchSqlAsyncClient(ElasticsearchTransport transport)

ElasticsearchSqlAsyncClient

public ElasticsearchSqlAsyncClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchSqlAsyncClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchSqlAsyncClient>

clearCursor

public CompletableFuture<ClearCursorResponse> clearCursor(ClearCursorRequest request)

Clear an SQL search cursor.

See Also:

• Documentation on elastic.co

clearCursor

public final CompletableFuture<ClearCursorResponse> clearCursor(Function<ClearCursorRequest.Builder,ObjectBuilder<ClearCursorRequest>> fn)

Clear an SQL search cursor.

Parameters:

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

See Also:

• Documentation on elastic.co

deleteAsync

public CompletableFuture<DeleteAsyncResponse> deleteAsync(DeleteAsyncRequest request)

Delete an async SQL search. Delete an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it.

If the Elasticsearch security features are enabled, only the following users can use this API to delete a search:

• Users with the cancel_task cluster privilege.
• The user who first submitted the search.

See Also:

• Documentation on elastic.co

deleteAsync

public final CompletableFuture<DeleteAsyncResponse> deleteAsync(Function<DeleteAsyncRequest.Builder,ObjectBuilder<DeleteAsyncRequest>> fn)

Delete an async SQL search. Delete an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it.

If the Elasticsearch security features are enabled, only the following users can use this API to delete a search:

• Users with the cancel_task cluster privilege.
• The user who first submitted the search.

Parameters:

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

See Also:

• Documentation on elastic.co

getAsync

public CompletableFuture<GetAsyncResponse> getAsync(GetAsyncRequest request)

Get async SQL search results. Get the current status and available results for an async SQL search or stored synchronous SQL search.

If the Elasticsearch security features are enabled, only the user who first submitted the SQL search can retrieve the search using this API.

See Also:

• Documentation on elastic.co

getAsync

public final CompletableFuture<GetAsyncResponse> getAsync(Function<GetAsyncRequest.Builder,ObjectBuilder<GetAsyncRequest>> fn)

Get async SQL search results. Get the current status and available results for an async SQL search or stored synchronous SQL search.

If the Elasticsearch security features are enabled, only the user who first submitted the SQL search can retrieve the search using this API.

Parameters:

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

See Also:

• Documentation on elastic.co

getAsyncStatus

public CompletableFuture<GetAsyncStatusResponse> getAsyncStatus(GetAsyncStatusRequest request)

Get the async SQL search status. Get the current status of an async SQL search or a stored synchronous SQL search.

See Also:

• Documentation on elastic.co

getAsyncStatus

public final CompletableFuture<GetAsyncStatusResponse> getAsyncStatus(Function<GetAsyncStatusRequest.Builder,ObjectBuilder<GetAsyncStatusRequest>> fn)

Get the async SQL search status. Get the current status of an async SQL search or a stored synchronous SQL search.

Parameters:

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

See Also:

• Documentation on elastic.co

query

public CompletableFuture<QueryResponse> query(QueryRequest request)

Get SQL search results. Run an SQL request.

See Also:

• Documentation on elastic.co

query

public final CompletableFuture<QueryResponse> query(Function<QueryRequest.Builder,ObjectBuilder<QueryRequest>> fn)

Get SQL search results. Run an SQL request.

Parameters:

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

See Also:

• Documentation on elastic.co

query

public CompletableFuture<QueryResponse> query()

Get SQL search results. Run an SQL request.

See Also:

• Documentation on elastic.co

translate

public CompletableFuture<TranslateResponse> translate(TranslateRequest request)

Translate SQL into Elasticsearch queries. Translate an SQL search into a search API request containing Query DSL. It accepts the same request body parameters as the SQL search API, excluding cursor.

See Also:

• Documentation on elastic.co

translate

public final CompletableFuture<TranslateResponse> translate(Function<TranslateRequest.Builder,ObjectBuilder<TranslateRequest>> fn)

Translate SQL into Elasticsearch queries. Translate an SQL search into a search API request containing Query DSL. It accepts the same request body parameters as the SQL search API, excluding cursor.

Parameters:

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

See Also:

• Documentation on elastic.co