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 Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
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
final EqlHits<TEvent>	hits()	Required - Contains matching events and sequences.
final String	id()	Identifier for the search.
final Boolean	isPartial()	If true, the response does not contain complete search results.
final 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)
final List<ShardFailure>	shardFailures()	Contains information about shard failures (if any), in case allow_partial_search_results=true
final Boolean	timedOut()	If true, the request timed out before completion.
final Long	took()	Milliseconds it took Elasticsearch to execute the request.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

EqlSearchResponseBase

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

Method Details

id

@Nullable
public final String id()

Identifier for the search.

API name: id

isPartial

@Nullable
public final Boolean isPartial()

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

API name: is_partial

isRunning

@Nullable
public final Boolean isRunning()

If true, the search request is still executing.

API name: is_running

took

@Nullable
public final Long took()

Milliseconds it took Elasticsearch to execute the request.

API name: took

timedOut

@Nullable
public final 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

shardFailures

public final List<ShardFailure> shardFailures()

Contains information about shard failures (if any), in case allow_partial_search_results=true

API name: shard_failures

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)

toString

public String toString()

Overrides:

toString in class Object

setupEqlSearchResponseBaseDeserializer

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