HitsEvent (java-client 7.15.1 API)

java.lang.Object

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

All Implemented Interfaces:: JsonpSerializable

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

Nested Class Summary

Nested Classes

Modifier and Type Class Description

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

Constructor Summary

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

Method Summary

Modifier and Type	Method	Description
`static <TEvent> JsonpDeserializer<HitsEvent<TEvent>>`	`createHitsEventDeserializer(JsonpDeserializer<TEvent> tEventDeserializer)`	Create a json deserializer for HitsEvent
`java.util.Map<java.lang.String,java.util.List<JsonData>>`	`fields()`	API name: `fields`
`java.lang.String`	`id()`	Required - Unique identifier for the event.
`java.lang.String`	`index()`	Required - Name of the index containing the event.
`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`	`setupHitsEventDeserializer(DelegatingDeserializer<HitsEvent.Builder<TEvent>> op, JsonpDeserializer<TEvent> tEventDeserializer)`
`TEvent`	`source()`	Required - Original JSON body passed for the event at index time.

Methods inherited from class java.lang.Object

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

Constructor Details
- HitsEvent
  
  public HitsEvent(HitsEvent.Builder<TEvent> builder)
- HitsEvent
  
  public HitsEvent(java.util.function.Function<HitsEvent.Builder<TEvent>,HitsEvent.Builder<TEvent>> fn)
Method Details
- index
  
  public java.lang.String index()
  
  Required - Name of the index containing the event.
  API name: _index
- id
  
  public java.lang.String id()
  
  Required - Unique identifier for the event. This ID is only unique within the index.
  API name: _id
- source
  
  public TEvent source()
  
  Required - Original JSON body passed for the event at index time.
  API name: _source
- fields
  
  @Nullable public java.util.Map<java.lang.String,java.util.List<JsonData>> fields()
  
  API name: fields
- 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)
- createHitsEventDeserializer
  
  public static <TEvent> JsonpDeserializer<HitsEvent<TEvent>> createHitsEventDeserializer(JsonpDeserializer<TEvent> tEventDeserializer)
  
  Create a json deserializer for HitsEvent
- setupHitsEventDeserializer
  
  protected static <TEvent> void setupHitsEventDeserializer(DelegatingDeserializer<HitsEvent.Builder<TEvent>> op, JsonpDeserializer<TEvent> tEventDeserializer)