Package co.elastic.clients.elasticsearch.eql

Class EqlHits<TEvent>

java.lang.Object

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

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class EqlHits<TEvent>
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<EqlHits<Object>>	_DESERIALIZER	Json deserializer for EqlHits based on named deserializers provided by the calling JsonMapper.

Method Summary

Modifier and Type	Method	Description
static <TEvent> JsonpDeserializer<EqlHits<TEvent>>	createEqlHitsDeserializer(JsonpDeserializer<TEvent> tEventDeserializer)	Create a JSON deserializer for EqlHits
final List<HitsEvent<TEvent>>	events()	Contains events matching the query.
static <TEvent> EqlHits<TEvent>	of(Function<EqlHits.Builder<TEvent>,ObjectBuilder<EqlHits<TEvent>>> fn)
final 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(ObjectDeserializer<EqlHits.Builder<TEvent>> op, JsonpDeserializer<TEvent> tEventDeserializer)
String	toString()
final 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, wait, wait, wait

Field Details

_DESERIALIZER

public static final JsonpDeserializer<EqlHits<Object>> _DESERIALIZER

Json deserializer for EqlHits based on named deserializers provided by the calling JsonMapper.

Method Details

of

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

total

@Nullable
public final TotalHits total()

Metadata about the number of matching events or sequences.

API name: total

events

public final List<HitsEvent<TEvent>> events()

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

API name: events

sequences

public final 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)

toString

public String toString()

Overrides:

toString in class Object

createEqlHitsDeserializer

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

Create a JSON deserializer for EqlHits

setupEqlHitsDeserializer

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