Package co.elastic.clients.elasticsearch.sql

Class ElasticsearchSqlClient

java.lang.Object

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

co.elastic.clients.elasticsearch.sql.ElasticsearchSqlClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class ElasticsearchSqlClient
extends ApiClient<ElasticsearchTransport,ElasticsearchSqlClient>

Client for the sql namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

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

ElasticsearchSqlClient

public ElasticsearchSqlClient(ElasticsearchTransport transport)

ElasticsearchSqlClient

public ElasticsearchSqlClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchSqlClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchSqlClient>

clearCursor

public ClearCursorResponse clearCursor(ClearCursorRequest request)
                                throws IOException,
ElasticsearchException

Clear an SQL search cursor.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

clearCursor

public final ClearCursorResponse clearCursor(Function<ClearCursorRequest.Builder,ObjectBuilder<ClearCursorRequest>> fn)
                                      throws IOException,
ElasticsearchException

Clear an SQL search cursor.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteAsync

public DeleteAsyncResponse deleteAsync(DeleteAsyncRequest request)
                                throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteAsync

public final DeleteAsyncResponse deleteAsync(Function<DeleteAsyncRequest.Builder,ObjectBuilder<DeleteAsyncRequest>> fn)
                                      throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getAsync

public GetAsyncResponse getAsync(GetAsyncRequest request)
                          throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getAsync

public final GetAsyncResponse getAsync(Function<GetAsyncRequest.Builder,ObjectBuilder<GetAsyncRequest>> fn)
                                throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getAsyncStatus

public GetAsyncStatusResponse getAsyncStatus(GetAsyncStatusRequest request)
                                      throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getAsyncStatus

public final GetAsyncStatusResponse getAsyncStatus(Function<GetAsyncStatusRequest.Builder,ObjectBuilder<GetAsyncStatusRequest>> fn)
                                            throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

query

public QueryResponse query(QueryRequest request)
                    throws IOException,
ElasticsearchException

Get SQL search results. Run an SQL request.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

query

public final QueryResponse query(Function<QueryRequest.Builder,ObjectBuilder<QueryRequest>> fn)
                          throws IOException,
ElasticsearchException

Get SQL search results. Run an SQL request.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

query

public QueryResponse query()
                    throws IOException,
ElasticsearchException

Get SQL search results. Run an SQL request.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

translate

public TranslateResponse translate(TranslateRequest request)
                            throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

translate

public final TranslateResponse translate(Function<TranslateRequest.Builder,ObjectBuilder<TranslateRequest>> fn)
                                  throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co