Package co.elastic.clients.elasticsearch.eql

Class ElasticsearchEqlClient

java.lang.Object

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

co.elastic.clients.elasticsearch.eql.ElasticsearchEqlClient

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)	Deletes an async EQL search by ID.
final EqlDeleteResponse	delete(Function<EqlDeleteRequest.Builder,ObjectBuilder<EqlDeleteRequest>> fn)	Deletes an async EQL search by ID.
<TEvent> EqlGetResponse<TEvent>	get(EqlGetRequest request, Class<TEvent> tEventClass)	Returns async results from previously executed Event Query Language (EQL) search
final <TEvent> EqlGetResponse<TEvent>	get(Function<EqlGetRequest.Builder,ObjectBuilder<EqlGetRequest>> fn, Class<TEvent> tEventClass)	Returns async results from previously executed Event Query Language (EQL) search
GetEqlStatusResponse	getStatus(GetEqlStatusRequest request)	Returns the status of a previously submitted async or stored Event Query Language (EQL) search
final GetEqlStatusResponse	getStatus(Function<GetEqlStatusRequest.Builder,ObjectBuilder<GetEqlStatusRequest>> fn)	Returns the status of a previously submitted async or stored Event Query Language (EQL) search
<TEvent> EqlSearchResponse<TEvent>	search(EqlSearchRequest request, Class<TEvent> tEventClass)	Returns results matching a query expressed in Event Query Language (EQL)
final <TEvent> EqlSearchResponse<TEvent>	search(Function<EqlSearchRequest.Builder,ObjectBuilder<EqlSearchRequest>> fn, Class<TEvent> tEventClass)	Returns results matching a query expressed in Event Query Language (EQL)
ElasticsearchEqlClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class co.elastic.clients.ApiClient

_jsonpMapper, _transport, _transportOptions, 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

Deletes an async EQL search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

delete

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

Deletes an async EQL search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted.

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

Returns async results from previously executed Event Query Language (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

Returns async results from previously executed Event Query Language (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

Returns the status of a previously submitted async or stored Event Query Language (EQL) search

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getStatus

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

Returns the status of a previously submitted async or stored Event Query Language (EQL) search

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

Returns results matching a query expressed in Event Query Language (EQL)

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

Returns results matching a query expressed in Event Query Language (EQL)

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co