Package co.elastic.clients.elasticsearch.esql

Class ElasticsearchEsqlClient

java.lang.Object

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

co.elastic.clients.elasticsearch.esql.ElasticsearchEsqlClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class ElasticsearchEsqlClient
extends ApiClient<ElasticsearchTransport,ElasticsearchEsqlClient>

Client for the esql namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
DeleteDatasetResponse	deleteDataset(DeleteDatasetRequest request)	Delete ES|QL datasets.
final DeleteDatasetResponse	deleteDataset(Function<DeleteDatasetRequest.Builder,ObjectBuilder<DeleteDatasetRequest>> fn)	Delete ES|QL datasets.
DeleteDataSourceResponse	deleteDataSource(DeleteDataSourceRequest request)	Delete ES|QL data sources.
final DeleteDataSourceResponse	deleteDataSource(Function<DeleteDataSourceRequest.Builder,ObjectBuilder<DeleteDataSourceRequest>> fn)	Delete ES|QL data sources.
DeleteViewResponse	deleteView(DeleteViewRequest request)	Delete an ES|QL view.
final DeleteViewResponse	deleteView(Function<DeleteViewRequest.Builder,ObjectBuilder<DeleteViewRequest>> fn)	Delete an ES|QL view.
GetDatasetResponse	getDataset()	Get ES|QL datasets.
GetDatasetResponse	getDataset(GetDatasetRequest request)	Get ES|QL datasets.
final GetDatasetResponse	getDataset(Function<GetDatasetRequest.Builder,ObjectBuilder<GetDatasetRequest>> fn)	Get ES|QL datasets.
GetDataSourceResponse	getDataSource()	Get ES|QL data sources.
GetDataSourceResponse	getDataSource(GetDataSourceRequest request)	Get ES|QL data sources.
final GetDataSourceResponse	getDataSource(Function<GetDataSourceRequest.Builder,ObjectBuilder<GetDataSourceRequest>> fn)	Get ES|QL data sources.
GetQueryResponse	getQuery(GetQueryRequest request)	Get a specific running ES|QL query information.
final GetQueryResponse	getQuery(Function<GetQueryRequest.Builder,ObjectBuilder<GetQueryRequest>> fn)	Get a specific running ES|QL query information.
GetViewResponse	getView()	Get an ES|QL view.
GetViewResponse	getView(GetViewRequest request)	Get an ES|QL view.
final GetViewResponse	getView(Function<GetViewRequest.Builder,ObjectBuilder<GetViewRequest>> fn)	Get an ES|QL view.
ListQueriesResponse	listQueries()	Get running ES|QL queries information.
PutDatasetResponse	putDataset(PutDatasetRequest request)	Create or update an ES|QL dataset.
final PutDatasetResponse	putDataset(Function<PutDatasetRequest.Builder,ObjectBuilder<PutDatasetRequest>> fn)	Create or update an ES|QL dataset.
PutDataSourceResponse	putDataSource(PutDataSourceRequest request)	Create or update an ES|QL data source.
final PutDataSourceResponse	putDataSource(Function<PutDataSourceRequest.Builder,ObjectBuilder<PutDataSourceRequest>> fn)	Create or update an ES|QL data source.
PutViewResponse	putView(PutViewRequest request)	Create or update an ES|QL view.
final PutViewResponse	putView(Function<PutViewRequest.Builder,ObjectBuilder<PutViewRequest>> fn)	Create or update an ES|QL view.
final <T> T	query(EsqlAdapter<T> adapter, QueryRequest request)	Executes an ES|QL request and adapts its result to a target type.
final <T> T	query(EsqlAdapter<T> adapter, String query, Object... parameters)	Executes an ES|QL request and adapts its result to a target type.
final <T> T	query(EsqlAdapter<T> adapter, Function<QueryRequest.Builder,ObjectBuilder<QueryRequest>> fn)	Executes an ES|QL request and adapts its result to a target type.
BinaryResponse	query(QueryRequest request)	Run an ES|QL query.
final BinaryResponse	query(Function<QueryRequest.Builder,ObjectBuilder<QueryRequest>> fn)	Run an ES|QL query.
ElasticsearchEsqlClient	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

ElasticsearchEsqlClient

public ElasticsearchEsqlClient(ElasticsearchTransport transport)

ElasticsearchEsqlClient

public ElasticsearchEsqlClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchEsqlClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchEsqlClient>

deleteDataSource

public DeleteDataSourceResponse deleteDataSource(DeleteDataSourceRequest request)
                                          throws IOException,
ElasticsearchException

Delete ES|QL data sources.

Deletes one or more data sources used in ES|QL data federation. Fails with 409 if any dataset references one of the named data sources; delete the dependent datasets first.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteDataSource

public final DeleteDataSourceResponse deleteDataSource(Function<DeleteDataSourceRequest.Builder,ObjectBuilder<DeleteDataSourceRequest>> fn)
                                                throws IOException,
ElasticsearchException

Delete ES|QL data sources.

Deletes one or more data sources used in ES|QL data federation. Fails with 409 if any dataset references one of the named data sources; delete the dependent datasets first.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteDataset

public DeleteDatasetResponse deleteDataset(DeleteDatasetRequest request)
                                    throws IOException,
ElasticsearchException

Delete ES|QL datasets.

Deletes one or more datasets used in ES|QL data federation. If any specified dataset does not exist, the request fails and no datasets are deleted.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteDataset

public final DeleteDatasetResponse deleteDataset(Function<DeleteDatasetRequest.Builder,ObjectBuilder<DeleteDatasetRequest>> fn)
                                          throws IOException,
ElasticsearchException

Delete ES|QL datasets.

Deletes one or more datasets used in ES|QL data federation. If any specified dataset does not exist, the request fails and no datasets are deleted.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteView

public DeleteViewResponse deleteView(DeleteViewRequest request)
                              throws IOException,
ElasticsearchException

Delete an ES|QL view.

Deletes a stored ES|QL view.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteView

public final DeleteViewResponse deleteView(Function<DeleteViewRequest.Builder,ObjectBuilder<DeleteViewRequest>> fn)
                                    throws IOException,
ElasticsearchException

Delete an ES|QL view.

Deletes a stored ES|QL view.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getDataSource

public GetDataSourceResponse getDataSource(GetDataSourceRequest request)
                                    throws IOException,
ElasticsearchException

Get ES|QL data sources.

Returns one or more data sources used in ES|QL data federation. A concrete-name miss returns 404; a wildcard pattern or list-all request with no match returns 200 with an empty array.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getDataSource

public final GetDataSourceResponse getDataSource(Function<GetDataSourceRequest.Builder,ObjectBuilder<GetDataSourceRequest>> fn)
                                          throws IOException,
ElasticsearchException

Get ES|QL data sources.

Returns one or more data sources used in ES|QL data federation. A concrete-name miss returns 404; a wildcard pattern or list-all request with no match returns 200 with an empty array.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getDataSource

public GetDataSourceResponse getDataSource()
                                    throws IOException,
ElasticsearchException

Get ES|QL data sources.

Returns one or more data sources used in ES|QL data federation. A concrete-name miss returns 404; a wildcard pattern or list-all request with no match returns 200 with an empty array.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getDataset

public GetDatasetResponse getDataset(GetDatasetRequest request)
                              throws IOException,
ElasticsearchException

Get ES|QL datasets.

Returns one or more datasets used in ES|QL data federation. A concrete-name miss returns 404; a wildcard pattern or list-all request with no match returns 200 with an empty array.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getDataset

public final GetDatasetResponse getDataset(Function<GetDatasetRequest.Builder,ObjectBuilder<GetDatasetRequest>> fn)
                                    throws IOException,
ElasticsearchException

Get ES|QL datasets.

Returns one or more datasets used in ES|QL data federation. A concrete-name miss returns 404; a wildcard pattern or list-all request with no match returns 200 with an empty array.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getDataset

public GetDatasetResponse getDataset()
                              throws IOException,
ElasticsearchException

Get ES|QL datasets.

Returns one or more datasets used in ES|QL data federation. A concrete-name miss returns 404; a wildcard pattern or list-all request with no match returns 200 with an empty array.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getQuery

public GetQueryResponse getQuery(GetQueryRequest request)
                          throws IOException,
ElasticsearchException

Get a specific running ES|QL query information.

Returns an object extended information about a running ES|QL query.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getQuery

public final GetQueryResponse getQuery(Function<GetQueryRequest.Builder,ObjectBuilder<GetQueryRequest>> fn)
                                throws IOException,
ElasticsearchException

Get a specific running ES|QL query information.

Returns an object extended information about a running ES|QL query.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getView

public GetViewResponse getView(GetViewRequest request)
                        throws IOException,
ElasticsearchException

Get an ES|QL view.

Returns a stored ES|QL view.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getView

public final GetViewResponse getView(Function<GetViewRequest.Builder,ObjectBuilder<GetViewRequest>> fn)
                              throws IOException,
ElasticsearchException

Get an ES|QL view.

Returns a stored ES|QL view.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getView

public GetViewResponse getView()
                        throws IOException,
ElasticsearchException

Get an ES|QL view.

Returns a stored ES|QL view.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

listQueries

public ListQueriesResponse listQueries()
                                throws IOException,
ElasticsearchException

Get running ES|QL queries information.

Returns an object containing IDs and other information about the running ES|QL queries.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putDataSource

public PutDataSourceResponse putDataSource(PutDataSourceRequest request)
                                    throws IOException,
ElasticsearchException

Create or update an ES|QL data source.

Creates or replaces a named, type-specific data source configuration for ES|QL data federation. Datasets reference data source configurations to access external data. Names must be lowercase and follow index or alias naming rules.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putDataSource

public final PutDataSourceResponse putDataSource(Function<PutDataSourceRequest.Builder,ObjectBuilder<PutDataSourceRequest>> fn)
                                          throws IOException,
ElasticsearchException

Create or update an ES|QL data source.

Creates or replaces a named, type-specific data source configuration for ES|QL data federation. Datasets reference data source configurations to access external data. Names must be lowercase and follow index or alias naming rules.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putDataset

public PutDatasetResponse putDataset(PutDatasetRequest request)
                              throws IOException,
ElasticsearchException

Create or update an ES|QL dataset.

Creates or replaces a dataset that references a data source in ES|QL data federation. Dataset names participate in the index namespace and must follow index or alias naming rules. Returns 404 if the referenced data source does not exist.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putDataset

public final PutDatasetResponse putDataset(Function<PutDatasetRequest.Builder,ObjectBuilder<PutDatasetRequest>> fn)
                                    throws IOException,
ElasticsearchException

Create or update an ES|QL dataset.

Creates or replaces a dataset that references a data source in ES|QL data federation. Dataset names participate in the index namespace and must follow index or alias naming rules. Returns 404 if the referenced data source does not exist.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putView

public PutViewResponse putView(PutViewRequest request)
                        throws IOException,
ElasticsearchException

Create or update an ES|QL view.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putView

public final PutViewResponse putView(Function<PutViewRequest.Builder,ObjectBuilder<PutViewRequest>> fn)
                              throws IOException,
ElasticsearchException

Create or update an ES|QL view.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

query

public BinaryResponse query(QueryRequest request)
                     throws IOException,
ElasticsearchException

Run an ES|QL query.

Get search results for an ES|QL (Elasticsearch query language) query.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

query

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

Run an ES|QL query.

Get search results for an ES|QL (Elasticsearch query language) query.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

query

public final <T> T query(EsqlAdapter<T> adapter,
 String query,
 Object... parameters)
                  throws IOException,
ElasticsearchException

Executes an ES|QL request and adapts its result to a target type.

Parameters:

adapter - the ES|QL response adapter

query - the ES|QL query

parameters - values for query parameters, if any

Throws:

IOException

ElasticsearchException

query

public final <T> T query(EsqlAdapter<T> adapter,
 QueryRequest request)
                  throws IOException,
ElasticsearchException

Executes an ES|QL request and adapts its result to a target type.

Parameters:

adapter - the ES|QL response adapter

request - the ES|QL request

Throws:

IOException

ElasticsearchException

query

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

Executes an ES|QL request and adapts its result to a target type.

Parameters:

adapter - the ES|QL response adapter

fn - the ES|QL request builder

Throws:

IOException

ElasticsearchException