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

Class InnerHits

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

  • Field Details

  • Method Details

    • of

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

    • name

      @Nullable public final String name()
      The name for the particular inner hit definition in the response. Useful when a search request contains multiple inner hits.

      API name: name

    • size

      @Nullable public final Integer size()
      The maximum number of hits to return per inner_hits.

      API name: size

    • from

      @Nullable public final Integer from()
      Inner hit starting document offset.

      API name: from

    • collapse

      @Nullable public final FieldCollapse collapse()
      API name: collapse

    • docvalueFields

      public final List<FieldAndFormat> docvalueFields()
      API name: docvalue_fields

    • explain

      @Nullable public final Boolean explain()
      API name: explain

    • highlight

      @Nullable public final Highlight highlight()
      API name: highlight

    • ignoreUnmapped

      @Nullable public final Boolean ignoreUnmapped()
      API name: ignore_unmapped

    • scriptFields

      public final Map<String,ScriptField> scriptFields()
      API name: script_fields

    • seqNoPrimaryTerm

      @Nullable public final Boolean seqNoPrimaryTerm()
      API name: seq_no_primary_term

    • fields

      public final List<String> fields()
      API name: fields

    • sort

      public final List<SortOptions> sort()
      How the inner hits should be sorted per inner_hits. By default, inner hits are sorted by score.

      API name: sort

    • source

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

    • storedFields

      public final List<String> storedFields()
      API name: stored_fields

    • trackScores

      @Nullable public final Boolean trackScores()
      API name: track_scores

    • version

      @Nullable public final Boolean 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)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • setupInnerHitsDeserializer

      protected static void setupInnerHitsDeserializer(ObjectDeserializer<InnerHits.Builder> op)