Package co.elastic.clients.elasticsearch.sql

Class ElasticsearchSqlClient

java.lang.Object

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

co.elastic.clients.elasticsearch.sql.ElasticsearchSqlClient

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)	Clears the SQL cursor
final ClearCursorResponse	clearCursor(Function<ClearCursorRequest.Builder,ObjectBuilder<ClearCursorRequest>> fn)	Clears the SQL cursor
DeleteAsyncResponse	deleteAsync(DeleteAsyncRequest request)	Deletes an async SQL search or a stored synchronous SQL search.
final DeleteAsyncResponse	deleteAsync(Function<DeleteAsyncRequest.Builder,ObjectBuilder<DeleteAsyncRequest>> fn)	Deletes an async SQL search or a stored synchronous SQL search.
GetAsyncResponse	getAsync(GetAsyncRequest request)	Returns the current status and available results for an async SQL search or stored synchronous SQL search
final GetAsyncResponse	getAsync(Function<GetAsyncRequest.Builder,ObjectBuilder<GetAsyncRequest>> fn)	Returns the current status and available results for an async SQL search or stored synchronous SQL search
GetAsyncStatusResponse	getAsyncStatus(GetAsyncStatusRequest request)	Returns the current status of an async SQL search or a stored synchronous SQL search
final GetAsyncStatusResponse	getAsyncStatus(Function<GetAsyncStatusRequest.Builder,ObjectBuilder<GetAsyncStatusRequest>> fn)	Returns the current status of an async SQL search or a stored synchronous SQL search
QueryResponse	query()	Executes a SQL request
QueryResponse	query(QueryRequest request)	Executes a SQL request
final QueryResponse	query(Function<QueryRequest.Builder,ObjectBuilder<QueryRequest>> fn)	Executes a SQL request
TranslateResponse	translate(TranslateRequest request)	Translates SQL into Elasticsearch queries
final TranslateResponse	translate(Function<TranslateRequest.Builder,ObjectBuilder<TranslateRequest>> fn)	Translates 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, 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

Clears the SQL cursor

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

clearCursor

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

Clears the SQL 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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteAsync

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

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

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getAsync

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

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

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

Returns 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

Returns 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

Executes a 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

Executes a 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

Executes a SQL request

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

translate

public TranslateResponse translate(TranslateRequest request)
                            throws IOException,
ElasticsearchException

Translates SQL into Elasticsearch queries

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

translate

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

Translates SQL into Elasticsearch queries

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co