Package co.elastic.clients.elasticsearch.core.search

Class Hit<TDocument>

java.lang.Object
co.elastic.clients.elasticsearch.core.search.Hit<TDocument>
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class Hit<TDocument> extends Object implements JsonpSerializable
See Also:

  • Field Details

    • _DESERIALIZER

      public static final JsonpDeserializer<Hit<Object>> _DESERIALIZER
      Json deserializer for Hit based on named deserializers provided by the calling JsonMapper.

  • Method Details

    • of

      public static <TDocument> Hit<TDocument> of(Function<Hit.Builder<TDocument>,ObjectBuilder<Hit<TDocument>>> fn)

    • index

      public final String index()
      Required - API name: _index

    • id

      public final String id()
      Required - API name: _id

    • score

      @Nullable public final Double score()
      API name: _score

      Defaults to Double.NaN if parsed from a JSON null value.

    • explanation

      @Nullable public final Explanation explanation()
      API name: _explanation

    • fields

      public final Map<String,JsonData> fields()
      API name: fields

    • highlight

      public final Map<String,List<String>> highlight()
      API name: highlight

    • innerHits

      public final Map<String,InnerHitsResult> innerHits()
      API name: inner_hits

    • matchedQueries

      public final List<String> matchedQueries()
      API name: matched_queries

    • nested

      @Nullable public final NestedIdentity nested()
      API name: _nested

    • ignored

      public final List<String> ignored()
      API name: _ignored

    • ignoredFieldValues

      public final Map<String,List<String>> ignoredFieldValues()
      API name: ignored_field_values

    • shard

      @Nullable public final String shard()
      API name: _shard

    • node

      @Nullable public final String node()
      API name: _node

    • routing

      @Nullable public final String routing()
      API name: _routing

    • source

      @Nullable public final TDocument source()
      API name: _source

    • seqNo

      @Nullable public final Long seqNo()
      API name: _seq_no

    • primaryTerm

      @Nullable public final Long primaryTerm()
      API name: _primary_term

    • version

      @Nullable public final Long version()
      API name: _version

    • sort

      public final List<FieldValue> sort()
      API name: sort

    • 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

    • createHitDeserializer

      public static <TDocument> JsonpDeserializer<Hit<TDocument>> createHitDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)
      Create a JSON deserializer for Hit

    • setupHitDeserializer

      protected static <TDocument> void setupHitDeserializer(ObjectDeserializer<Hit.Builder<TDocument>> op, JsonpDeserializer<TDocument> tDocumentDeserializer)