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<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<ListQueriesResponse>	listQueries()	Get running ES|QL queries information.
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>

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

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

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