Package co.elastic.clients.elasticsearch.eql

Class ElasticsearchEqlClient

java.lang.Object

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

co.elastic.clients.elasticsearch.eql.ElasticsearchEqlClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class ElasticsearchEqlClient
extends ApiClient<ElasticsearchTransport,ElasticsearchEqlClient>

Client for the eql namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
EqlDeleteResponse	delete(EqlDeleteRequest request)	Delete an async EQL search.
final EqlDeleteResponse	delete(Function<EqlDeleteRequest.Builder,ObjectBuilder<EqlDeleteRequest>> fn)	Delete an async EQL search.
EqlGetResponse<Void>	get(EqlGetRequest request)	Overload of get(EqlGetRequest, Class), where Class is defined as Void, meaning the documents will not be deserialized.
<TEvent> EqlGetResponse<TEvent>	get(EqlGetRequest request, Class<TEvent> tEventClass)	Get async EQL search results.
<TEvent> EqlGetResponse<TEvent>	get(EqlGetRequest request, Type tEventType)	Get async EQL search results.
final EqlGetResponse<Void>	get(Function<EqlGetRequest.Builder,ObjectBuilder<EqlGetRequest>> fn)	Overload of get(Function, Class), where Class is defined as Void, meaning the documents will not be deserialized.
final <TEvent> EqlGetResponse<TEvent>	get(Function<EqlGetRequest.Builder,ObjectBuilder<EqlGetRequest>> fn, Class<TEvent> tEventClass)	Get async EQL search results.
final <TEvent> EqlGetResponse<TEvent>	get(Function<EqlGetRequest.Builder,ObjectBuilder<EqlGetRequest>> fn, Type tEventType)	Get async EQL search results.
GetEqlStatusResponse	getStatus(GetEqlStatusRequest request)	Get the async EQL status.
final GetEqlStatusResponse	getStatus(Function<GetEqlStatusRequest.Builder,ObjectBuilder<GetEqlStatusRequest>> fn)	Get the async EQL status.
EqlSearchResponse<Void>	search(EqlSearchRequest request)	Overload of search(EqlSearchRequest, Class), where Class is defined as Void, meaning the documents will not be deserialized.
<TEvent> EqlSearchResponse<TEvent>	search(EqlSearchRequest request, Class<TEvent> tEventClass)	Get EQL search results.
<TEvent> EqlSearchResponse<TEvent>	search(EqlSearchRequest request, Type tEventType)	Get EQL search results.
final EqlSearchResponse<Void>	search(Function<EqlSearchRequest.Builder,ObjectBuilder<EqlSearchRequest>> fn)	Overload of search(Function, Class), where Class is defined as Void, meaning the documents will not be deserialized.
final <TEvent> EqlSearchResponse<TEvent>	search(Function<EqlSearchRequest.Builder,ObjectBuilder<EqlSearchRequest>> fn, Class<TEvent> tEventClass)	Get EQL search results.
final <TEvent> EqlSearchResponse<TEvent>	search(Function<EqlSearchRequest.Builder,ObjectBuilder<EqlSearchRequest>> fn, Type tEventType)	Get EQL search results.
ElasticsearchEqlClient	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

ElasticsearchEqlClient

public ElasticsearchEqlClient(ElasticsearchTransport transport)

ElasticsearchEqlClient

public ElasticsearchEqlClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchEqlClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchEqlClient>

delete

public EqlDeleteResponse delete(EqlDeleteRequest request)
                         throws IOException,
ElasticsearchException

Delete an async EQL search. Delete an async EQL search or a stored synchronous EQL search. The API also deletes results for the search.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

delete

public final EqlDeleteResponse delete(Function<EqlDeleteRequest.Builder,ObjectBuilder<EqlDeleteRequest>> fn)
                               throws IOException,
ElasticsearchException

Delete an async EQL search. Delete an async EQL search or a stored synchronous EQL search. The API also deletes results for the search.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

get

public <TEvent> EqlGetResponse<TEvent> get(EqlGetRequest request,
 Class<TEvent> tEventClass)
                                    throws IOException,
ElasticsearchException

Get async EQL search results. Get the current status and available results for an async EQL search or a stored synchronous EQL search.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

get

public final <TEvent> EqlGetResponse<TEvent> get(Function<EqlGetRequest.Builder,ObjectBuilder<EqlGetRequest>> fn,
 Class<TEvent> tEventClass)
                                          throws IOException,
ElasticsearchException

Get async EQL search results. Get the current status and available results for an async EQL search or a stored synchronous EQL search.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

get

public EqlGetResponse<Void> get(EqlGetRequest request)
                         throws IOException,
ElasticsearchException

Overload of get(EqlGetRequest, Class), where Class is defined as Void, meaning the documents will not be deserialized.

Throws:

IOException

ElasticsearchException

get

public final EqlGetResponse<Void> get(Function<EqlGetRequest.Builder,ObjectBuilder<EqlGetRequest>> fn)
                               throws IOException,
ElasticsearchException

Overload of get(Function, Class), where Class is defined as Void, meaning the documents will not be deserialized.

Throws:

IOException

ElasticsearchException

get

public <TEvent> EqlGetResponse<TEvent> get(EqlGetRequest request,
 Type tEventType)
                                    throws IOException,
ElasticsearchException

Get async EQL search results. Get the current status and available results for an async EQL search or a stored synchronous EQL search.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

get

public final <TEvent> EqlGetResponse<TEvent> get(Function<EqlGetRequest.Builder,ObjectBuilder<EqlGetRequest>> fn,
 Type tEventType)
                                          throws IOException,
ElasticsearchException

Get async EQL search results. Get the current status and available results for an async EQL search or a stored synchronous EQL search.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getStatus

public GetEqlStatusResponse getStatus(GetEqlStatusRequest request)
                               throws IOException,
ElasticsearchException

Get the async EQL status. Get the current status for an async EQL search or a stored synchronous EQL search without returning results.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getStatus

public final GetEqlStatusResponse getStatus(Function<GetEqlStatusRequest.Builder,ObjectBuilder<GetEqlStatusRequest>> fn)
                                     throws IOException,
ElasticsearchException

Get the async EQL status. Get the current status for an async EQL search or a stored synchronous EQL search without returning results.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

search

public <TEvent> EqlSearchResponse<TEvent> search(EqlSearchRequest request,
 Class<TEvent> tEventClass)
                                          throws IOException,
ElasticsearchException

Get EQL search results. Returns search results for an Event Query Language (EQL) query. EQL assumes each document in a data stream or index corresponds to an event.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

search

public final <TEvent> EqlSearchResponse<TEvent> search(Function<EqlSearchRequest.Builder,ObjectBuilder<EqlSearchRequest>> fn,
 Class<TEvent> tEventClass)
                                                throws IOException,
ElasticsearchException

Get EQL search results. Returns search results for an Event Query Language (EQL) query. EQL assumes each document in a data stream or index corresponds to an event.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

search

public EqlSearchResponse<Void> search(EqlSearchRequest request)
                               throws IOException,
ElasticsearchException

Overload of search(EqlSearchRequest, Class), where Class is defined as Void, meaning the documents will not be deserialized.

Throws:

IOException

ElasticsearchException

search

public final EqlSearchResponse<Void> search(Function<EqlSearchRequest.Builder,ObjectBuilder<EqlSearchRequest>> fn)
                                     throws IOException,
ElasticsearchException

Overload of search(Function, Class), where Class is defined as Void, meaning the documents will not be deserialized.

Throws:

IOException

ElasticsearchException

search

public <TEvent> EqlSearchResponse<TEvent> search(EqlSearchRequest request,
 Type tEventType)
                                          throws IOException,
ElasticsearchException

Get EQL search results. Returns search results for an Event Query Language (EQL) query. EQL assumes each document in a data stream or index corresponds to an event.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

search

public final <TEvent> EqlSearchResponse<TEvent> search(Function<EqlSearchRequest.Builder,ObjectBuilder<EqlSearchRequest>> fn,
 Type tEventType)
                                                throws IOException,
ElasticsearchException

Get EQL search results. Returns search results for an Event Query Language (EQL) query. EQL assumes each document in a data stream or index corresponds to an event.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co