Package co.elastic.clients.elasticsearch.eql

Class EqlHits<TEvent>

java.lang.Object

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

All Implemented Interfaces:

JsonpSerializable

public final class EqlHits<TEvent>
extends java.lang.Object
implements JsonpSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EqlHits.Builder<TEvent>	Builder for EqlHits.

Constructor Summary

Constructors

Constructor	Description
EqlHits(EqlHits.Builder<TEvent> builder)
EqlHits(java.util.function.Function<EqlHits.Builder<TEvent>,EqlHits.Builder<TEvent>> fn)

Method Summary

Modifier and Type	Method	Description
static <TEvent> JsonpDeserializer<EqlHits<TEvent>>	createEqlHitsDeserializer(JsonpDeserializer<TEvent> tEventDeserializer)	Create a json deserializer for EqlHits
java.util.List<HitsEvent<TEvent>>	events()	Contains events matching the query.
java.util.List<HitsSequence<TEvent>>	sequences()	Contains event sequences matching the query.
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> void	setupEqlHitsDeserializer(DelegatingDeserializer<EqlHits.Builder<TEvent>> op, JsonpDeserializer<TEvent> tEventDeserializer)
TotalHits	total()	Metadata about the number of matching events or sequences.

Methods inherited from class java.lang.Object

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

Constructor Details

EqlHits

public EqlHits(EqlHits.Builder<TEvent> builder)

EqlHits

public EqlHits(java.util.function.Function<EqlHits.Builder<TEvent>,EqlHits.Builder<TEvent>> fn)

Method Details

total

@Nullable
public TotalHits total()

Metadata about the number of matching events or sequences.

API name: total

events

@Nullable
public java.util.List<HitsEvent<TEvent>> events()

Contains events matching the query. Each object represents a matching event.

API name: events

sequences

@Nullable
public java.util.List<HitsSequence<TEvent>> sequences()

Contains event sequences matching the query. Each object represents a matching sequence. This parameter is only returned for EQL queries containing a sequence.

API name: sequences

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)

createEqlHitsDeserializer

public static <TEvent>
JsonpDeserializer<EqlHits<TEvent>> createEqlHitsDeserializer(JsonpDeserializer<TEvent> tEventDeserializer)

Create a json deserializer for EqlHits

setupEqlHitsDeserializer

protected static <TEvent> void setupEqlHitsDeserializer(DelegatingDeserializer<EqlHits.Builder<TEvent>> op,
JsonpDeserializer<TEvent> tEventDeserializer)