HitsSequence (java-client 7.16.3 API)

java.lang.Object

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

All Implemented Interfaces:: JsonpSerializable

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

See Also:: API specification

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class HitsSequence.Builder<TEvent>
Builder for HitsSequence.

Method Summary

Modifier and Type	Method	Description
`static <TEvent> JsonpDeserializer<HitsSequence<TEvent>>`	`createHitsSequenceDeserializer(JsonpDeserializer<TEvent> tEventDeserializer)`	Create a JSON deserializer for HitsSequence
`java.util.List<HitsEvent<TEvent>>`	`events()`	Required - Contains events matching the query.
`java.util.List<JsonData>`	`joinKeys()`	Required - Shared field values used to constrain matches in the sequence.
`static <TEvent> HitsSequence<TEvent>`	`of(java.util.function.Function<HitsSequence.Builder<TEvent>,ObjectBuilder<HitsSequence<TEvent>>> fn)`
`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`	`setupHitsSequenceDeserializer(ObjectDeserializer<HitsSequence.Builder<TEvent>> op, JsonpDeserializer<TEvent> tEventDeserializer)`

Methods inherited from class java.lang.Object

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

Method Details
- of
  
  public static <TEvent> HitsSequence<TEvent> of(java.util.function.Function<HitsSequence.Builder<TEvent>,ObjectBuilder<HitsSequence<TEvent>>> fn)
- events
  
  public final java.util.List<HitsEvent<TEvent>> events()
  
  Required - Contains events matching the query. Each object represents a matching event.
  API name: events
- joinKeys
  
  public final java.util.List<JsonData> joinKeys()
  
  Required - Shared field values used to constrain matches in the sequence. These are defined using the by keyword in the EQL query syntax.
  API name: join_keys
- 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)
- createHitsSequenceDeserializer
  
  public static <TEvent> JsonpDeserializer<HitsSequence<TEvent>> createHitsSequenceDeserializer(JsonpDeserializer<TEvent> tEventDeserializer)
  
  Create a JSON deserializer for HitsSequence
- setupHitsSequenceDeserializer
  
  protected static <TEvent> void setupHitsSequenceDeserializer(ObjectDeserializer<HitsSequence.Builder<TEvent>> op, JsonpDeserializer<TEvent> tEventDeserializer)