Interface HitsMetadataHitsInnerOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
HitsMetadataHitsInner, HitsMetadataHitsInner.Builder

public interface HitsMetadataHitsInnerOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    map<string, .org.opensearch.protobufs.StringArray> highlight = 7 [json_name = "highlight"];
    boolean
    map<string, .org.opensearch.protobufs.StringArray> ignored_field_values = 12 [json_name = "ignoredFieldValues"];
    boolean
    map<string, .org.opensearch.protobufs.InnerHitsResult> inner_hits = 8 [json_name = "innerHits"];
    optional .org.opensearch.protobufs.ObjectMap fields = 6 [json_name = "fields"];
    optional .org.opensearch.protobufs.ObjectMap fields = 6 [json_name = "fields"];
    Deprecated.
    int
    map<string, .org.opensearch.protobufs.StringArray> highlight = 7 [json_name = "highlight"];
    map<string, .org.opensearch.protobufs.StringArray> highlight = 7 [json_name = "highlight"];
    map<string, .org.opensearch.protobufs.StringArray> highlight = 7 [json_name = "highlight"];
    map<string, .org.opensearch.protobufs.StringArray> highlight = 7 [json_name = "highlight"];
    Deprecated.
    int
    map<string, .org.opensearch.protobufs.StringArray> ignored_field_values = 12 [json_name = "ignoredFieldValues"];
    map<string, .org.opensearch.protobufs.StringArray> ignored_field_values = 12 [json_name = "ignoredFieldValues"];
    map<string, .org.opensearch.protobufs.StringArray> ignored_field_values = 12 [json_name = "ignoredFieldValues"];
    map<string, .org.opensearch.protobufs.StringArray> ignored_field_values = 12 [json_name = "ignoredFieldValues"];
    Deprecated.
    int
    map<string, .org.opensearch.protobufs.InnerHitsResult> inner_hits = 8 [json_name = "innerHits"];
    map<string, .org.opensearch.protobufs.InnerHitsResult> inner_hits = 8 [json_name = "innerHits"];
    map<string, .org.opensearch.protobufs.InnerHitsResult> inner_hits = 8 [json_name = "innerHits"];
    map<string, .org.opensearch.protobufs.InnerHitsResult> inner_hits = 8 [json_name = "innerHits"];
    getMatchedQueries(int index)
    Deprecated.
    org.opensearch.protobufs.HitsMetadataHitsInner.matched_queries is deprecated.
    optional .org.opensearch.protobufs.HitMatchedQueries matched_queries_2 = 22 [json_name = "matchedQueries2"];
    optional .org.opensearch.protobufs.HitMatchedQueries matched_queries_2 = 22 [json_name = "matchedQueries2"];
    com.google.protobuf.ByteString
    Deprecated.
    org.opensearch.protobufs.HitsMetadataHitsInner.matched_queries is deprecated.
    int
    Deprecated.
    org.opensearch.protobufs.HitsMetadataHitsInner.matched_queries is deprecated.
    Deprecated.
    org.opensearch.protobufs.HitsMetadataHitsInner.matched_queries is deprecated.
    optional .org.opensearch.protobufs.ObjectMap meta_fields = 21 [json_name = "metaFields"];
    optional .org.opensearch.protobufs.ObjectMap meta_fields = 21 [json_name = "metaFields"];
    getSort(int index)
    repeated .org.opensearch.protobufs.FieldValue sort = 20 [json_name = "sort"];
    int
    repeated .org.opensearch.protobufs.FieldValue sort = 20 [json_name = "sort"];
    repeated .org.opensearch.protobufs.FieldValue sort = 20 [json_name = "sort"];
    getSortOrBuilder(int index)
    repeated .org.opensearch.protobufs.FieldValue sort = 20 [json_name = "sort"];
    repeated .org.opensearch.protobufs.FieldValue sort = 20 [json_name = "sort"];
    optional .org.opensearch.protobufs.Explanation x_explanation = 5 [json_name = "xExplanation"];
    optional .org.opensearch.protobufs.Explanation x_explanation = 5 [json_name = "xExplanation"];
    optional string x_id = 3 [json_name = "xId"];
    com.google.protobuf.ByteString
    optional string x_id = 3 [json_name = "xId"];
    getXIgnored(int index)
    repeated string x_ignored = 11 [json_name = "xIgnored"];
    com.google.protobuf.ByteString
    getXIgnoredBytes(int index)
    repeated string x_ignored = 11 [json_name = "xIgnored"];
    int
    repeated string x_ignored = 11 [json_name = "xIgnored"];
    repeated string x_ignored = 11 [json_name = "xIgnored"];
    optional string x_index = 2 [json_name = "xIndex"];
    com.google.protobuf.ByteString
    optional string x_index = 2 [json_name = "xIndex"];
    optional .org.opensearch.protobufs.NestedIdentity x_nested = 10 [json_name = "xNested"];
    optional .org.opensearch.protobufs.NestedIdentity x_nested = 10 [json_name = "xNested"];
    optional string x_node = 14 [json_name = "xNode"];
    com.google.protobuf.ByteString
    optional string x_node = 14 [json_name = "xNode"];
    long
    optional int64 x_primary_term = 18 [json_name = "xPrimaryTerm"];
    optional string x_routing = 15 [json_name = "xRouting"];
    com.google.protobuf.ByteString
    optional string x_routing = 15 [json_name = "xRouting"];
    optional .org.opensearch.protobufs.HitXScore x_score = 4 [json_name = "xScore"];
    optional .org.opensearch.protobufs.HitXScore x_score = 4 [json_name = "xScore"];
    long
    optional int64 x_seq_no = 17 [json_name = "xSeqNo"];
    optional string x_shard = 13 [json_name = "xShard"];
    com.google.protobuf.ByteString
    optional string x_shard = 13 [json_name = "xShard"];
    com.google.protobuf.ByteString
    optional bytes x_source = 16 [json_name = "xSource"];
    optional string x_type = 1 [json_name = "xType"];
    com.google.protobuf.ByteString
    optional string x_type = 1 [json_name = "xType"];
    long
    optional int64 x_version = 19 [json_name = "xVersion"];
    boolean
    optional .org.opensearch.protobufs.ObjectMap fields = 6 [json_name = "fields"];
    boolean
    optional .org.opensearch.protobufs.HitMatchedQueries matched_queries_2 = 22 [json_name = "matchedQueries2"];
    boolean
    optional .org.opensearch.protobufs.ObjectMap meta_fields = 21 [json_name = "metaFields"];
    boolean
    optional .org.opensearch.protobufs.Explanation x_explanation = 5 [json_name = "xExplanation"];
    boolean
    optional string x_id = 3 [json_name = "xId"];
    boolean
    optional string x_index = 2 [json_name = "xIndex"];
    boolean
    optional .org.opensearch.protobufs.NestedIdentity x_nested = 10 [json_name = "xNested"];
    boolean
    optional string x_node = 14 [json_name = "xNode"];
    boolean
    optional int64 x_primary_term = 18 [json_name = "xPrimaryTerm"];
    boolean
    optional string x_routing = 15 [json_name = "xRouting"];
    boolean
    optional .org.opensearch.protobufs.HitXScore x_score = 4 [json_name = "xScore"];
    boolean
    optional int64 x_seq_no = 17 [json_name = "xSeqNo"];
    boolean
    optional string x_shard = 13 [json_name = "xShard"];
    boolean
    optional bytes x_source = 16 [json_name = "xSource"];
    boolean
    optional string x_type = 1 [json_name = "xType"];
    boolean
    optional int64 x_version = 19 [json_name = "xVersion"];

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
  • Method Details

    • hasXType

      boolean hasXType()
      optional string x_type = 1 [json_name = "xType"];
      Returns:
      Whether the xType field is set.
    • getXType

      String getXType()
      optional string x_type = 1 [json_name = "xType"];
      Returns:
      The xType.
    • getXTypeBytes

      com.google.protobuf.ByteString getXTypeBytes()
      optional string x_type = 1 [json_name = "xType"];
      Returns:
      The bytes for xType.
    • hasXIndex

      boolean hasXIndex()
      optional string x_index = 2 [json_name = "xIndex"];
      Returns:
      Whether the xIndex field is set.
    • getXIndex

      String getXIndex()
      optional string x_index = 2 [json_name = "xIndex"];
      Returns:
      The xIndex.
    • getXIndexBytes

      com.google.protobuf.ByteString getXIndexBytes()
      optional string x_index = 2 [json_name = "xIndex"];
      Returns:
      The bytes for xIndex.
    • hasXId

      boolean hasXId()
      optional string x_id = 3 [json_name = "xId"];
      Returns:
      Whether the xId field is set.
    • getXId

      String getXId()
      optional string x_id = 3 [json_name = "xId"];
      Returns:
      The xId.
    • getXIdBytes

      com.google.protobuf.ByteString getXIdBytes()
      optional string x_id = 3 [json_name = "xId"];
      Returns:
      The bytes for xId.
    • hasXScore

      boolean hasXScore()
      optional .org.opensearch.protobufs.HitXScore x_score = 4 [json_name = "xScore"];
      Returns:
      Whether the xScore field is set.
    • getXScore

      HitXScore getXScore()
      optional .org.opensearch.protobufs.HitXScore x_score = 4 [json_name = "xScore"];
      Returns:
      The xScore.
    • getXScoreOrBuilder

      HitXScoreOrBuilder getXScoreOrBuilder()
      optional .org.opensearch.protobufs.HitXScore x_score = 4 [json_name = "xScore"];
    • hasXExplanation

      boolean hasXExplanation()
      optional .org.opensearch.protobufs.Explanation x_explanation = 5 [json_name = "xExplanation"];
      Returns:
      Whether the xExplanation field is set.
    • getXExplanation

      Explanation getXExplanation()
      optional .org.opensearch.protobufs.Explanation x_explanation = 5 [json_name = "xExplanation"];
      Returns:
      The xExplanation.
    • getXExplanationOrBuilder

      ExplanationOrBuilder getXExplanationOrBuilder()
      optional .org.opensearch.protobufs.Explanation x_explanation = 5 [json_name = "xExplanation"];
    • hasFields

      boolean hasFields()
      optional .org.opensearch.protobufs.ObjectMap fields = 6 [json_name = "fields"];
      Returns:
      Whether the fields field is set.
    • getFields

      ObjectMap getFields()
      optional .org.opensearch.protobufs.ObjectMap fields = 6 [json_name = "fields"];
      Returns:
      The fields.
    • getFieldsOrBuilder

      ObjectMapOrBuilder getFieldsOrBuilder()
      optional .org.opensearch.protobufs.ObjectMap fields = 6 [json_name = "fields"];
    • getHighlightCount

      int getHighlightCount()
      map<string, .org.opensearch.protobufs.StringArray> highlight = 7 [json_name = "highlight"];
    • containsHighlight

      boolean containsHighlight(String key)
      map<string, .org.opensearch.protobufs.StringArray> highlight = 7 [json_name = "highlight"];
    • getHighlight

      Deprecated.
      Use getHighlightMap() instead.
    • getHighlightMap

      Map<String,StringArray> getHighlightMap()
      map<string, .org.opensearch.protobufs.StringArray> highlight = 7 [json_name = "highlight"];
    • getHighlightOrDefault

      StringArray getHighlightOrDefault(String key, StringArray defaultValue)
      map<string, .org.opensearch.protobufs.StringArray> highlight = 7 [json_name = "highlight"];
    • getHighlightOrThrow

      StringArray getHighlightOrThrow(String key)
      map<string, .org.opensearch.protobufs.StringArray> highlight = 7 [json_name = "highlight"];
    • getInnerHitsCount

      int getInnerHitsCount()
      map<string, .org.opensearch.protobufs.InnerHitsResult> inner_hits = 8 [json_name = "innerHits"];
    • containsInnerHits

      boolean containsInnerHits(String key)
      map<string, .org.opensearch.protobufs.InnerHitsResult> inner_hits = 8 [json_name = "innerHits"];
    • getInnerHits

      Deprecated.
      Use getInnerHitsMap() instead.
    • getInnerHitsMap

      Map<String,InnerHitsResult> getInnerHitsMap()
      map<string, .org.opensearch.protobufs.InnerHitsResult> inner_hits = 8 [json_name = "innerHits"];
    • getInnerHitsOrDefault

      InnerHitsResult getInnerHitsOrDefault(String key, InnerHitsResult defaultValue)
      map<string, .org.opensearch.protobufs.InnerHitsResult> inner_hits = 8 [json_name = "innerHits"];
    • getInnerHitsOrThrow

      InnerHitsResult getInnerHitsOrThrow(String key)
      map<string, .org.opensearch.protobufs.InnerHitsResult> inner_hits = 8 [json_name = "innerHits"];
    • getMatchedQueriesList

      @Deprecated List<String> getMatchedQueriesList()
      Deprecated.
      org.opensearch.protobufs.HitsMetadataHitsInner.matched_queries is deprecated. See protos/schemas/common.proto;l=0
      repeated string matched_queries = 9 [json_name = "matchedQueries", deprecated = true];
      Returns:
      A list containing the matchedQueries.
    • getMatchedQueriesCount

      @Deprecated int getMatchedQueriesCount()
      Deprecated.
      org.opensearch.protobufs.HitsMetadataHitsInner.matched_queries is deprecated. See protos/schemas/common.proto;l=0
      repeated string matched_queries = 9 [json_name = "matchedQueries", deprecated = true];
      Returns:
      The count of matchedQueries.
    • getMatchedQueries

      @Deprecated String getMatchedQueries(int index)
      Deprecated.
      org.opensearch.protobufs.HitsMetadataHitsInner.matched_queries is deprecated. See protos/schemas/common.proto;l=0
      repeated string matched_queries = 9 [json_name = "matchedQueries", deprecated = true];
      Parameters:
      index - The index of the element to return.
      Returns:
      The matchedQueries at the given index.
    • getMatchedQueriesBytes

      @Deprecated com.google.protobuf.ByteString getMatchedQueriesBytes(int index)
      Deprecated.
      org.opensearch.protobufs.HitsMetadataHitsInner.matched_queries is deprecated. See protos/schemas/common.proto;l=0
      repeated string matched_queries = 9 [json_name = "matchedQueries", deprecated = true];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the matchedQueries at the given index.
    • hasXNested

      boolean hasXNested()
      optional .org.opensearch.protobufs.NestedIdentity x_nested = 10 [json_name = "xNested"];
      Returns:
      Whether the xNested field is set.
    • getXNested

      NestedIdentity getXNested()
      optional .org.opensearch.protobufs.NestedIdentity x_nested = 10 [json_name = "xNested"];
      Returns:
      The xNested.
    • getXNestedOrBuilder

      NestedIdentityOrBuilder getXNestedOrBuilder()
      optional .org.opensearch.protobufs.NestedIdentity x_nested = 10 [json_name = "xNested"];
    • getXIgnoredList

      List<String> getXIgnoredList()
      repeated string x_ignored = 11 [json_name = "xIgnored"];
      Returns:
      A list containing the xIgnored.
    • getXIgnoredCount

      int getXIgnoredCount()
      repeated string x_ignored = 11 [json_name = "xIgnored"];
      Returns:
      The count of xIgnored.
    • getXIgnored

      String getXIgnored(int index)
      repeated string x_ignored = 11 [json_name = "xIgnored"];
      Parameters:
      index - The index of the element to return.
      Returns:
      The xIgnored at the given index.
    • getXIgnoredBytes

      com.google.protobuf.ByteString getXIgnoredBytes(int index)
      repeated string x_ignored = 11 [json_name = "xIgnored"];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the xIgnored at the given index.
    • getIgnoredFieldValuesCount

      int getIgnoredFieldValuesCount()
      map<string, .org.opensearch.protobufs.StringArray> ignored_field_values = 12 [json_name = "ignoredFieldValues"];
    • containsIgnoredFieldValues

      boolean containsIgnoredFieldValues(String key)
      map<string, .org.opensearch.protobufs.StringArray> ignored_field_values = 12 [json_name = "ignoredFieldValues"];
    • getIgnoredFieldValues

      @Deprecated Map<String,StringArray> getIgnoredFieldValues()
      Deprecated.
    • getIgnoredFieldValuesMap

      Map<String,StringArray> getIgnoredFieldValuesMap()
      map<string, .org.opensearch.protobufs.StringArray> ignored_field_values = 12 [json_name = "ignoredFieldValues"];
    • getIgnoredFieldValuesOrDefault

      StringArray getIgnoredFieldValuesOrDefault(String key, StringArray defaultValue)
      map<string, .org.opensearch.protobufs.StringArray> ignored_field_values = 12 [json_name = "ignoredFieldValues"];
    • getIgnoredFieldValuesOrThrow

      StringArray getIgnoredFieldValuesOrThrow(String key)
      map<string, .org.opensearch.protobufs.StringArray> ignored_field_values = 12 [json_name = "ignoredFieldValues"];
    • hasXShard

      boolean hasXShard()
      optional string x_shard = 13 [json_name = "xShard"];
      Returns:
      Whether the xShard field is set.
    • getXShard

      String getXShard()
      optional string x_shard = 13 [json_name = "xShard"];
      Returns:
      The xShard.
    • getXShardBytes

      com.google.protobuf.ByteString getXShardBytes()
      optional string x_shard = 13 [json_name = "xShard"];
      Returns:
      The bytes for xShard.
    • hasXNode

      boolean hasXNode()
      optional string x_node = 14 [json_name = "xNode"];
      Returns:
      Whether the xNode field is set.
    • getXNode

      String getXNode()
      optional string x_node = 14 [json_name = "xNode"];
      Returns:
      The xNode.
    • getXNodeBytes

      com.google.protobuf.ByteString getXNodeBytes()
      optional string x_node = 14 [json_name = "xNode"];
      Returns:
      The bytes for xNode.
    • hasXRouting

      boolean hasXRouting()
      optional string x_routing = 15 [json_name = "xRouting"];
      Returns:
      Whether the xRouting field is set.
    • getXRouting

      String getXRouting()
      optional string x_routing = 15 [json_name = "xRouting"];
      Returns:
      The xRouting.
    • getXRoutingBytes

      com.google.protobuf.ByteString getXRoutingBytes()
      optional string x_routing = 15 [json_name = "xRouting"];
      Returns:
      The bytes for xRouting.
    • hasXSource

      boolean hasXSource()
      optional bytes x_source = 16 [json_name = "xSource"];
      Returns:
      Whether the xSource field is set.
    • getXSource

      com.google.protobuf.ByteString getXSource()
      optional bytes x_source = 16 [json_name = "xSource"];
      Returns:
      The xSource.
    • hasXSeqNo

      boolean hasXSeqNo()
      optional int64 x_seq_no = 17 [json_name = "xSeqNo"];
      Returns:
      Whether the xSeqNo field is set.
    • getXSeqNo

      long getXSeqNo()
      optional int64 x_seq_no = 17 [json_name = "xSeqNo"];
      Returns:
      The xSeqNo.
    • hasXPrimaryTerm

      boolean hasXPrimaryTerm()
      optional int64 x_primary_term = 18 [json_name = "xPrimaryTerm"];
      Returns:
      Whether the xPrimaryTerm field is set.
    • getXPrimaryTerm

      long getXPrimaryTerm()
      optional int64 x_primary_term = 18 [json_name = "xPrimaryTerm"];
      Returns:
      The xPrimaryTerm.
    • hasXVersion

      boolean hasXVersion()
      optional int64 x_version = 19 [json_name = "xVersion"];
      Returns:
      Whether the xVersion field is set.
    • getXVersion

      long getXVersion()
      optional int64 x_version = 19 [json_name = "xVersion"];
      Returns:
      The xVersion.
    • getSortList

      List<FieldValue> getSortList()
      repeated .org.opensearch.protobufs.FieldValue sort = 20 [json_name = "sort"];
    • getSort

      FieldValue getSort(int index)
      repeated .org.opensearch.protobufs.FieldValue sort = 20 [json_name = "sort"];
    • getSortCount

      int getSortCount()
      repeated .org.opensearch.protobufs.FieldValue sort = 20 [json_name = "sort"];
    • getSortOrBuilderList

      List<? extends FieldValueOrBuilder> getSortOrBuilderList()
      repeated .org.opensearch.protobufs.FieldValue sort = 20 [json_name = "sort"];
    • getSortOrBuilder

      FieldValueOrBuilder getSortOrBuilder(int index)
      repeated .org.opensearch.protobufs.FieldValue sort = 20 [json_name = "sort"];
    • hasMetaFields

      boolean hasMetaFields()
      optional .org.opensearch.protobufs.ObjectMap meta_fields = 21 [json_name = "metaFields"];
      Returns:
      Whether the metaFields field is set.
    • getMetaFields

      ObjectMap getMetaFields()
      optional .org.opensearch.protobufs.ObjectMap meta_fields = 21 [json_name = "metaFields"];
      Returns:
      The metaFields.
    • getMetaFieldsOrBuilder

      ObjectMapOrBuilder getMetaFieldsOrBuilder()
      optional .org.opensearch.protobufs.ObjectMap meta_fields = 21 [json_name = "metaFields"];
    • hasMatchedQueries2

      boolean hasMatchedQueries2()
      optional .org.opensearch.protobufs.HitMatchedQueries matched_queries_2 = 22 [json_name = "matchedQueries2"];
      Returns:
      Whether the matchedQueries2 field is set.
    • getMatchedQueries2

      HitMatchedQueries getMatchedQueries2()
      optional .org.opensearch.protobufs.HitMatchedQueries matched_queries_2 = 22 [json_name = "matchedQueries2"];
      Returns:
      The matchedQueries2.
    • getMatchedQueries2OrBuilder

      HitMatchedQueriesOrBuilder getMatchedQueries2OrBuilder()
      optional .org.opensearch.protobufs.HitMatchedQueries matched_queries_2 = 22 [json_name = "matchedQueries2"];