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

Class InnerHits

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

  • Field Details

  • Method Details

    • of

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

    • collapse

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

    • docvalueFields

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

    • explain

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

    • fields

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

    • from

      @Nullable public final Integer from()
      The inner hit that initiates document offset.

      API name: from

    • highlight

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

    • ignoreUnmapped

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

    • name

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

    • scriptFields

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

    • seqNoPrimaryTerm

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

    • size

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

      API name: size

    • sort

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

    • source

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

    • storedFields

      @Nonnull 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)

    • toBuilder

      @Nonnull public InnerHits.Builder 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<InnerHits.Builder,InnerHits>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static InnerHits.Builder builder()

    • setupInnerHitsDeserializer

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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