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

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

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

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