Package org.opensearch.client.opensearch.core.search

Class Hit<TDocument>

java.lang.Object
org.opensearch.client.opensearch.core.search.Hit<TDocument>
All Implemented Interfaces:
JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<Hit.Builder<TDocument>,Hit<TDocument>>
@Generated("org.opensearch.client.codegen.CodeGenerator") public class Hit<TDocument> extends Object implements PlainJsonSerializable, ToCopyableBuilder<Hit.Builder<TDocument>,Hit<TDocument>>

  • Method Details

    • of

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

    • explanation

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

    • fields

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

    • highlight

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

    • id

      @Nullable public final String id()
      API name: _id

    • ignored

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

    • ignoredFieldValues

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

    • index

      @Nullable public final String index()
      API name: _index

    • innerHits

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

    • matchedQueries

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

    • nested

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

    • node

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

    • primaryTerm

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

    • routing

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

    • score

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

    • seqNo

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

    • shard

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

    • sort

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

    • source

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

    • tDocumentSerializer

      @Nullable public final JsonpSerializer<TDocument> tDocumentSerializer()
      Serializer for TDocument. If not set, an attempt will be made to find a serializer from the JSON context.

    • version

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

    • 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)

    • toBuilder

      @Nonnull public Hit.Builder<TDocument> toBuilder()
      Description copied from interface: ToCopyableBuilder
      Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Hit.Builder<TDocument>,Hit<TDocument>>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static <TDocument> Hit.Builder builder()

    • 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)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object