Package co.elastic.clients.elasticsearch.eql

Class EqlSearchResponseBase<TEvent>

java.lang.Object

co.elastic.clients.elasticsearch.eql.EqlSearchResponseBase<TEvent>

All Implemented Interfaces:

JsonpSerializable

Direct Known Subclasses:

EqlGetResponse, EqlSearchResponse

public abstract class EqlSearchResponseBase<TEvent>
extends java.lang.Object
implements JsonpSerializable

See Also:

Documentation on elastic.co, API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	EqlSearchResponseBase.AbstractBuilder<TEvent,BuilderT extends EqlSearchResponseBase.AbstractBuilder<TEvent,BuilderT>>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EqlSearchResponseBase(EqlSearchResponseBase.AbstractBuilder<TEvent,?> builder)

Method Summary

Modifier and Type	Method	Description
EqlHits<TEvent>	hits()	Required - Contains matching events and sequences.
java.lang.String	id()	Identifier for the search.
java.lang.Boolean	isPartial()	If true, the response does not contain complete search results.
java.lang.Boolean	isRunning()	If true, the search request is still executing.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static <TEvent, BuilderT extends EqlSearchResponseBase.AbstractBuilder<TEvent, BuilderT>> void	setupEqlSearchResponseBaseDeserializer(ObjectDeserializer<BuilderT> op, JsonpDeserializer<TEvent> tEventDeserializer)
java.lang.Boolean	timedOut()	If true, the request timed out before completion.
java.lang.Integer	took()	Milliseconds it took Elasticsearch to execute the request.

Methods inherited from class java.lang.Object

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

Constructor Details

EqlSearchResponseBase

protected EqlSearchResponseBase(EqlSearchResponseBase.AbstractBuilder<TEvent,?> builder)

Method Details

id

@Nullable
public final java.lang.String id()

Identifier for the search.

API name: id

isPartial

@Nullable
public final java.lang.Boolean isPartial()

If true, the response does not contain complete search results.

API name: is_partial

isRunning

@Nullable
public final java.lang.Boolean isRunning()

If true, the search request is still executing.

API name: is_running

took

@Nullable
public final java.lang.Integer took()

Milliseconds it took Elasticsearch to execute the request.

API name: took

timedOut

@Nullable
public final java.lang.Boolean timedOut()

If true, the request timed out before completion.

API name: timed_out

hits

public final EqlHits<TEvent> hits()

Required - Contains matching events and sequences. Also contains related metadata.

API name: hits

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
JsonpMapper mapper)

setupEqlSearchResponseBaseDeserializer

protected static <TEvent,
BuilderT extends EqlSearchResponseBase.AbstractBuilder<TEvent,
BuilderT>>
void setupEqlSearchResponseBaseDeserializer(ObjectDeserializer<BuilderT> op,
JsonpDeserializer<TEvent> tEventDeserializer)