Package org.opensearch.client.opensearch._global.search

Class Hit<TDocument>

java.lang.Object
org.opensearch.client.opensearch._global.search.Hit<TDocument>
All Implemented Interfaces:
ToJsonp
public final class Hit<TDocument>
extends java.lang.Object
implements ToJsonp

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  Hit.Builder<TDocument>
    Builder for Hit.

  • Constructor Summary

    Constructors 
    Modifier Constructor Description
    protected Hit​(Hit.Builder<TDocument> builder)  

  • Method Summary

    Modifier and Type Method Description
    static <TDocument>
    JsonpDeserializer<Hit<TDocument>>    		 createHitDeserializer​(JsonpDeserializer<TDocument> tDocumentDeserializer)
    Create a json deserializer for Hit
    Explanation explanation()
    API name: _explanation
    java.util.Map<java.lang.String,​jakarta.json.JsonValue> fields()
    API name: fields
    java.util.Map<java.lang.String,​java.util.List<java.lang.String>> highlight()
    API name: highlight
    java.lang.String id()
    API name: _id
    java.util.List<java.lang.String> ignored()
    API name: _ignored
    java.lang.String index()
    API name: _index
    java.util.Map<java.lang.String,​InnerHitsResult> innerHits()
    API name: inner_hits
    java.util.List<java.lang.String> matchedQueries()
    API name: matched_queries
    NestedIdentity nested()
    API name: _nested
    java.lang.String node()
    API name: _node
    java.lang.Number primaryTerm()
    API name: _primary_term
    java.lang.String routing()
    API name: _routing
    java.lang.Number score()
    API name: _score
    java.lang.Number seqNo()
    API name: _seq_no
    protected static <TDocument>
    void    		 setupHitDeserializer​(DelegatingDeserializer<Hit.Builder<TDocument>> op, JsonpDeserializer<TDocument> tDocumentDeserializer)  
    java.lang.String shard()
    API name: _shard
    java.util.List<jakarta.json.JsonValue> sort()
    API name: sort
    TDocument source()
    API name: _source
    void toJsonp​(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
    Serialize this object to JSON.
    protected void toJsonpInternal​(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)  
    java.lang.String type()
    API name: _type
    java.lang.Number version()
    API name: _version

    Methods inherited from class java.lang.Object

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

  • Constructor Details

  • Method Details

    • index

      public java.lang.String index()
      API name: _index

    • id

      public java.lang.String id()
      API name: _id

    • score

      @Nullable public java.lang.Number score()
      API name: _score

    • type

      @Nullable public java.lang.String type()
      API name: _type

    • explanation

      @Nullable public Explanation explanation()
      API name: _explanation

    • fields

      @Nullable public java.util.Map<java.lang.String,​jakarta.json.JsonValue> fields()
      API name: fields

    • highlight

      @Nullable public java.util.Map<java.lang.String,​java.util.List<java.lang.String>> highlight()
      API name: highlight

    • innerHits

      @Nullable public java.util.Map<java.lang.String,​InnerHitsResult> innerHits()
      API name: inner_hits

    • matchedQueries

      @Nullable public java.util.List<java.lang.String> matchedQueries()
      API name: matched_queries

    • nested

      @Nullable public NestedIdentity nested()
      API name: _nested

    • ignored

      @Nullable public java.util.List<java.lang.String> ignored()
      API name: _ignored

    • shard

      @Nullable public java.lang.String shard()
      API name: _shard

    • node

      @Nullable public java.lang.String node()
      API name: _node

    • routing

      @Nullable public java.lang.String routing()
      API name: _routing

    • source

      @Nullable public TDocument source()
      API name: _source

    • seqNo

      @Nullable public java.lang.Number seqNo()
      API name: _seq_no

    • primaryTerm

      @Nullable public java.lang.Number primaryTerm()
      API name: _primary_term

    • version

      @Nullable public java.lang.Number version()
      API name: _version

    • sort

      @Nullable public java.util.List<jakarta.json.JsonValue> sort()
      API name: sort

    • toJsonp

      public void toJsonp​(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      toJsonp in interface ToJsonp

    • toJsonpInternal

      protected void toJsonpInternal​(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • createHitDeserializer

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

    • setupHitDeserializer

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