Package co.elastic.clients.elasticsearch.esql

Class ElasticsearchEsqlAsyncClient

java.lang.Object

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

co.elastic.clients.elasticsearch.esql.ElasticsearchEsqlAsyncClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class ElasticsearchEsqlAsyncClient
extends ApiClient<ElasticsearchTransport,ElasticsearchEsqlAsyncClient>

Client for the esql namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

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

ElasticsearchEsqlAsyncClient

public ElasticsearchEsqlAsyncClient(ElasticsearchTransport transport)

ElasticsearchEsqlAsyncClient

public ElasticsearchEsqlAsyncClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchEsqlAsyncClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchEsqlAsyncClient>

deleteDataSource

public CompletableFuture<DeleteDataSourceResponse> deleteDataSource(DeleteDataSourceRequest request)

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.

See Also:

• Documentation on elastic.co

deleteDataSource

public final CompletableFuture<DeleteDataSourceResponse> deleteDataSource(Function<DeleteDataSourceRequest.Builder,ObjectBuilder<DeleteDataSourceRequest>> fn)

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

See Also:

• Documentation on elastic.co

deleteDataset

public CompletableFuture<DeleteDatasetResponse> deleteDataset(DeleteDatasetRequest request)

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.

See Also:

• Documentation on elastic.co

deleteDataset

public final CompletableFuture<DeleteDatasetResponse> deleteDataset(Function<DeleteDatasetRequest.Builder,ObjectBuilder<DeleteDatasetRequest>> fn)

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

See Also:

• Documentation on elastic.co

deleteView

public CompletableFuture<DeleteViewResponse> deleteView(DeleteViewRequest request)

Delete an ES|QL view.

Deletes a stored ES|QL view.

See Also:

• Documentation on elastic.co

deleteView

public final CompletableFuture<DeleteViewResponse> deleteView(Function<DeleteViewRequest.Builder,ObjectBuilder<DeleteViewRequest>> fn)

Delete an ES|QL view.

Deletes a stored ES|QL view.

Parameters:

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

See Also:

• Documentation on elastic.co

getDataSource

public CompletableFuture<GetDataSourceResponse> getDataSource(GetDataSourceRequest request)

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.

See Also:

• Documentation on elastic.co

getDataSource

public final CompletableFuture<GetDataSourceResponse> getDataSource(Function<GetDataSourceRequest.Builder,ObjectBuilder<GetDataSourceRequest>> fn)

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

See Also:

• Documentation on elastic.co

getDataSource

public CompletableFuture<GetDataSourceResponse> getDataSource()

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.

See Also:

• Documentation on elastic.co

getDataset

public CompletableFuture<GetDatasetResponse> getDataset(GetDatasetRequest request)

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.

See Also:

• Documentation on elastic.co

getDataset

public final CompletableFuture<GetDatasetResponse> getDataset(Function<GetDatasetRequest.Builder,ObjectBuilder<GetDatasetRequest>> fn)

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

See Also:

• Documentation on elastic.co

getDataset

public CompletableFuture<GetDatasetResponse> getDataset()

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.

See Also:

• Documentation on elastic.co

getQuery

public CompletableFuture<GetQueryResponse> getQuery(GetQueryRequest request)

Get a specific running ES|QL query information.

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

See Also:

• Documentation on elastic.co

getQuery

public final CompletableFuture<GetQueryResponse> getQuery(Function<GetQueryRequest.Builder,ObjectBuilder<GetQueryRequest>> fn)

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

See Also:

• Documentation on elastic.co

getView

public CompletableFuture<GetViewResponse> getView(GetViewRequest request)

Get an ES|QL view.

Returns a stored ES|QL view.

See Also:

• Documentation on elastic.co

getView

public final CompletableFuture<GetViewResponse> getView(Function<GetViewRequest.Builder,ObjectBuilder<GetViewRequest>> fn)

Get an ES|QL view.

Returns a stored ES|QL view.

Parameters:

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

See Also:

• Documentation on elastic.co

getView

public CompletableFuture<GetViewResponse> getView()

Get an ES|QL view.

Returns a stored ES|QL view.

See Also:

• Documentation on elastic.co

listQueries

public CompletableFuture<ListQueriesResponse> listQueries()

Get running ES|QL queries information.

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

See Also:

• Documentation on elastic.co

putDataSource

public CompletableFuture<PutDataSourceResponse> putDataSource(PutDataSourceRequest request)

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.

See Also:

• Documentation on elastic.co

putDataSource

public final CompletableFuture<PutDataSourceResponse> putDataSource(Function<PutDataSourceRequest.Builder,ObjectBuilder<PutDataSourceRequest>> fn)

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

See Also:

• Documentation on elastic.co

putDataset

public CompletableFuture<PutDatasetResponse> putDataset(PutDatasetRequest request)

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.

See Also:

• Documentation on elastic.co

putDataset

public final CompletableFuture<PutDatasetResponse> putDataset(Function<PutDatasetRequest.Builder,ObjectBuilder<PutDatasetRequest>> fn)

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

See Also:

• Documentation on elastic.co

putView

public CompletableFuture<PutViewResponse> putView(PutViewRequest request)

Create or update an ES|QL view.

See Also:

• Documentation on elastic.co

putView

public final CompletableFuture<PutViewResponse> putView(Function<PutViewRequest.Builder,ObjectBuilder<PutViewRequest>> fn)

Create or update an ES|QL view.

Parameters:

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

See Also:

• Documentation on elastic.co

query

public CompletableFuture<BinaryResponse> query(QueryRequest request)

Run an ES|QL query.

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

See Also:

• Documentation on elastic.co

query

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

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

See Also:

• Documentation on elastic.co

query

public final <T> CompletableFuture<T> query(EsqlAdapter<T> adapter,
 String query,
 Object... parameters)

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

query

public final <T> CompletableFuture<T> query(EsqlAdapter<T> adapter,
 QueryRequest request)

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

query

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

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