EqlHits (java-client 7.16.3 API)

java.lang.Object

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

All Implemented Interfaces:: JsonpSerializable

public class EqlHits<TEvent>
extends java.lang.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.

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.
`static <TEvent> EqlHits<TEvent>`	`of(java.util.function.Function<EqlHits.Builder<TEvent>,ObjectBuilder<EqlHits<TEvent>>> fn)`
`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(ObjectDeserializer<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

Method Details
- of
  
  public static <TEvent> EqlHits<TEvent> of(java.util.function.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 java.util.List<HitsEvent<TEvent>> events()
  
  Contains events matching the query. Each object represents a matching event.
  API name: events
- sequences
  
  public final 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(ObjectDeserializer<EqlHits.Builder<TEvent>> op, JsonpDeserializer<TEvent> tEventDeserializer)