Package co.elastic.clients.elasticsearch.eql

Class EqlGetRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.eql.EqlGetRequest

public class EqlGetRequest
extends RequestBase

Returns async results from previously executed Event Query Language (EQL) search

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EqlGetRequest.Builder	Builder for EqlGetRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final SimpleEndpoint<EqlGetRequest,?>	_ENDPOINT	Endpoint "eql.get".

Method Summary

Modifier and Type	Method	Description
static <TEvent> Endpoint<EqlGetRequest,EqlGetResponse<TEvent>,ErrorResponse>	createGetEndpoint(JsonpDeserializer<TEvent> tEventDeserializer)	Create an "eql.get" endpoint.
final String	id()	Required - Identifier for the search.
final Time	keepAlive()	Period for which the search and its results are stored on the cluster.
static EqlGetRequest	of(Function<EqlGetRequest.Builder,ObjectBuilder<EqlGetRequest>> fn)
final Time	waitForCompletionTimeout()	Timeout duration to wait for the request to finish.

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_ENDPOINT

public static final SimpleEndpoint<EqlGetRequest,?> _ENDPOINT

Endpoint "eql.get".

Method Details

of

public static EqlGetRequest of(Function<EqlGetRequest.Builder,ObjectBuilder<EqlGetRequest>> fn)

id

public final String id()

Required - Identifier for the search.

API name: id

keepAlive

@Nullable
public final Time keepAlive()

Period for which the search and its results are stored on the cluster. Defaults to the keep_alive value set by the search’s EQL search API request.

API name: keep_alive

waitForCompletionTimeout

@Nullable
public final Time waitForCompletionTimeout()

Timeout duration to wait for the request to finish. Defaults to no timeout, meaning the request waits for complete search results.

API name: wait_for_completion_timeout

createGetEndpoint

public static <TEvent>
Endpoint<EqlGetRequest,EqlGetResponse<TEvent>,ErrorResponse> createGetEndpoint(JsonpDeserializer<TEvent> tEventDeserializer)

Create an "eql.get" endpoint.