Package org.opensearch.protobufs

Interface HighlightOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Highlight, Highlight.Builder
public interface HighlightOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsFields(String key)
    map<string, .org.opensearch.protobufs.HighlightField> fields = 24 [json_name = "fields"];
    String
    getBoundaryChars()
    optional string boundary_chars = 2 [json_name = "boundaryChars"];
    com.google.protobuf.ByteString
    getBoundaryCharsBytes()
    optional string boundary_chars = 2 [json_name = "boundaryChars"];
    int
    getBoundaryMaxScan()
    optional int32 boundary_max_scan = 3 [json_name = "boundaryMaxScan"];
    BoundaryScanner
    getBoundaryScanner()
    optional .org.opensearch.protobufs.BoundaryScanner boundary_scanner = 4 [json_name = "boundaryScanner"];
    String
    getBoundaryScannerLocale()
    optional string boundary_scanner_locale = 5 [json_name = "boundaryScannerLocale"];
    com.google.protobuf.ByteString
    getBoundaryScannerLocaleBytes()
    optional string boundary_scanner_locale = 5 [json_name = "boundaryScannerLocale"];
    int
    getBoundaryScannerValue()
    optional .org.opensearch.protobufs.BoundaryScanner boundary_scanner = 4 [json_name = "boundaryScanner"];
    HighlighterEncoder
    getEncoder()
    optional .org.opensearch.protobufs.HighlighterEncoder encoder = 23 [json_name = "encoder"];
    int
    getEncoderValue()
    optional .org.opensearch.protobufs.HighlighterEncoder encoder = 23 [json_name = "encoder"];
    Map<String,HighlightField>
    getFields()
    Deprecated.
    int
    getFieldsCount()
    map<string, .org.opensearch.protobufs.HighlightField> fields = 24 [json_name = "fields"];
    Map<String,HighlightField>
    getFieldsMap()
    map<string, .org.opensearch.protobufs.HighlightField> fields = 24 [json_name = "fields"];
    HighlightField
    getFieldsOrDefault(String key, HighlightField defaultValue)
    map<string, .org.opensearch.protobufs.HighlightField> fields = 24 [json_name = "fields"];
    HighlightField
    getFieldsOrThrow(String key)
    map<string, .org.opensearch.protobufs.HighlightField> fields = 24 [json_name = "fields"];
    boolean
    getForceSource()
    optional bool force_source = 6 [json_name = "forceSource"];
    HighlighterFragmenter
    getFragmenter()
    optional .org.opensearch.protobufs.HighlighterFragmenter fragmenter = 7 [json_name = "fragmenter"];
    int
    getFragmenterValue()
    optional .org.opensearch.protobufs.HighlighterFragmenter fragmenter = 7 [json_name = "fragmenter"];
    int
    getFragmentOffset()
    optional int32 fragment_offset = 8 [json_name = "fragmentOffset"];
    int
    getFragmentSize()
    optional int32 fragment_size = 9 [json_name = "fragmentSize"];
    boolean
    getHighlightFilter()
    optional bool highlight_filter = 10 [json_name = "highlightFilter"];
    QueryContainer
    getHighlightQuery()
    optional .org.opensearch.protobufs.QueryContainer highlight_query = 11 [json_name = "highlightQuery"];
    QueryContainerOrBuilder
    getHighlightQueryOrBuilder()
    optional .org.opensearch.protobufs.QueryContainer highlight_query = 11 [json_name = "highlightQuery"];
    int
    getMaxAnalyzerOffset()
    optional int32 max_analyzer_offset = 13 [json_name = "maxAnalyzerOffset"];
    int
    getMaxFragmentLength()
    optional int32 max_fragment_length = 12 [json_name = "maxFragmentLength"];
    int
    getNoMatchSize()
    optional int32 no_match_size = 14 [json_name = "noMatchSize"];
    int
    getNumberOfFragments()
    optional int32 number_of_fragments = 15 [json_name = "numberOfFragments"];
    ObjectMap
    getOptions()
    optional .org.opensearch.protobufs.ObjectMap options = 16 [json_name = "options"];
    ObjectMapOrBuilder
    getOptionsOrBuilder()
    optional .org.opensearch.protobufs.ObjectMap options = 16 [json_name = "options"];
    HighlighterOrder
    getOrder()
    optional .org.opensearch.protobufs.HighlighterOrder order = 17 [json_name = "order"];
    int
    getOrderValue()
    optional .org.opensearch.protobufs.HighlighterOrder order = 17 [json_name = "order"];
    int
    getPhraseLimit()
    optional int32 phrase_limit = 18 [json_name = "phraseLimit"];
    String
    getPostTags(int index)
    repeated string post_tags = 19 [json_name = "postTags"];
    com.google.protobuf.ByteString
    getPostTagsBytes(int index)
    repeated string post_tags = 19 [json_name = "postTags"];
    int
    getPostTagsCount()
    repeated string post_tags = 19 [json_name = "postTags"];
    List<String>
    getPostTagsList()
    repeated string post_tags = 19 [json_name = "postTags"];
    String
    getPreTags(int index)
    repeated string pre_tags = 20 [json_name = "preTags"];
    com.google.protobuf.ByteString
    getPreTagsBytes(int index)
    repeated string pre_tags = 20 [json_name = "preTags"];
    int
    getPreTagsCount()
    repeated string pre_tags = 20 [json_name = "preTags"];
    List<String>
    getPreTagsList()
    repeated string pre_tags = 20 [json_name = "preTags"];
    boolean
    getRequireFieldMatch()
    optional bool require_field_match = 21 [json_name = "requireFieldMatch"];
    HighlighterTagsSchema
    getTagsSchema()
    optional .org.opensearch.protobufs.HighlighterTagsSchema tags_schema = 22 [json_name = "tagsSchema"];
    int
    getTagsSchemaValue()
    optional .org.opensearch.protobufs.HighlighterTagsSchema tags_schema = 22 [json_name = "tagsSchema"];
    HighlighterType
    getType()
    optional .org.opensearch.protobufs.HighlighterType type = 1 [json_name = "type"];
    HighlighterTypeOrBuilder
    getTypeOrBuilder()
    optional .org.opensearch.protobufs.HighlighterType type = 1 [json_name = "type"];
    boolean
    hasBoundaryChars()
    optional string boundary_chars = 2 [json_name = "boundaryChars"];
    boolean
    hasBoundaryMaxScan()
    optional int32 boundary_max_scan = 3 [json_name = "boundaryMaxScan"];
    boolean
    hasBoundaryScanner()
    optional .org.opensearch.protobufs.BoundaryScanner boundary_scanner = 4 [json_name = "boundaryScanner"];
    boolean
    hasBoundaryScannerLocale()
    optional string boundary_scanner_locale = 5 [json_name = "boundaryScannerLocale"];
    boolean
    hasEncoder()
    optional .org.opensearch.protobufs.HighlighterEncoder encoder = 23 [json_name = "encoder"];
    boolean
    hasForceSource()
    optional bool force_source = 6 [json_name = "forceSource"];
    boolean
    hasFragmenter()
    optional .org.opensearch.protobufs.HighlighterFragmenter fragmenter = 7 [json_name = "fragmenter"];
    boolean
    hasFragmentOffset()
    optional int32 fragment_offset = 8 [json_name = "fragmentOffset"];
    boolean
    hasFragmentSize()
    optional int32 fragment_size = 9 [json_name = "fragmentSize"];
    boolean
    hasHighlightFilter()
    optional bool highlight_filter = 10 [json_name = "highlightFilter"];
    boolean
    hasHighlightQuery()
    optional .org.opensearch.protobufs.QueryContainer highlight_query = 11 [json_name = "highlightQuery"];
    boolean
    hasMaxAnalyzerOffset()
    optional int32 max_analyzer_offset = 13 [json_name = "maxAnalyzerOffset"];
    boolean
    hasMaxFragmentLength()
    optional int32 max_fragment_length = 12 [json_name = "maxFragmentLength"];
    boolean
    hasNoMatchSize()
    optional int32 no_match_size = 14 [json_name = "noMatchSize"];
    boolean
    hasNumberOfFragments()
    optional int32 number_of_fragments = 15 [json_name = "numberOfFragments"];
    boolean
    hasOptions()
    optional .org.opensearch.protobufs.ObjectMap options = 16 [json_name = "options"];
    boolean
    hasOrder()
    optional .org.opensearch.protobufs.HighlighterOrder order = 17 [json_name = "order"];
    boolean
    hasPhraseLimit()
    optional int32 phrase_limit = 18 [json_name = "phraseLimit"];
    boolean
    hasRequireFieldMatch()
    optional bool require_field_match = 21 [json_name = "requireFieldMatch"];
    boolean
    hasTagsSchema()
    optional .org.opensearch.protobufs.HighlighterTagsSchema tags_schema = 22 [json_name = "tagsSchema"];
    boolean
    hasType()
    optional .org.opensearch.protobufs.HighlighterType type = 1 [json_name = "type"];

    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

    • hasType

      boolean hasType()
      optional .org.opensearch.protobufs.HighlighterType type = 1 [json_name = "type"];
      Returns:
      Whether the type field is set.

    • getType

      HighlighterType getType()
      optional .org.opensearch.protobufs.HighlighterType type = 1 [json_name = "type"];
      Returns:
      The type.

    • getTypeOrBuilder

      HighlighterTypeOrBuilder getTypeOrBuilder()
      optional .org.opensearch.protobufs.HighlighterType type = 1 [json_name = "type"];

    • hasBoundaryChars

      boolean hasBoundaryChars()
      optional string boundary_chars = 2 [json_name = "boundaryChars"];
      Returns:
      Whether the boundaryChars field is set.

    • getBoundaryChars

      String getBoundaryChars()
      optional string boundary_chars = 2 [json_name = "boundaryChars"];
      Returns:
      The boundaryChars.

    • getBoundaryCharsBytes

      com.google.protobuf.ByteString getBoundaryCharsBytes()
      optional string boundary_chars = 2 [json_name = "boundaryChars"];
      Returns:
      The bytes for boundaryChars.

    • hasBoundaryMaxScan

      boolean hasBoundaryMaxScan()
      optional int32 boundary_max_scan = 3 [json_name = "boundaryMaxScan"];
      Returns:
      Whether the boundaryMaxScan field is set.

    • getBoundaryMaxScan

      int getBoundaryMaxScan()
      optional int32 boundary_max_scan = 3 [json_name = "boundaryMaxScan"];
      Returns:
      The boundaryMaxScan.

    • hasBoundaryScanner

      boolean hasBoundaryScanner()
      optional .org.opensearch.protobufs.BoundaryScanner boundary_scanner = 4 [json_name = "boundaryScanner"];
      Returns:
      Whether the boundaryScanner field is set.

    • getBoundaryScannerValue

      int getBoundaryScannerValue()
      optional .org.opensearch.protobufs.BoundaryScanner boundary_scanner = 4 [json_name = "boundaryScanner"];
      Returns:
      The enum numeric value on the wire for boundaryScanner.

    • getBoundaryScanner

      BoundaryScanner getBoundaryScanner()
      optional .org.opensearch.protobufs.BoundaryScanner boundary_scanner = 4 [json_name = "boundaryScanner"];
      Returns:
      The boundaryScanner.

    • hasBoundaryScannerLocale

      boolean hasBoundaryScannerLocale()
      optional string boundary_scanner_locale = 5 [json_name = "boundaryScannerLocale"];
      Returns:
      Whether the boundaryScannerLocale field is set.

    • getBoundaryScannerLocale

      String getBoundaryScannerLocale()
      optional string boundary_scanner_locale = 5 [json_name = "boundaryScannerLocale"];
      Returns:
      The boundaryScannerLocale.

    • getBoundaryScannerLocaleBytes

      com.google.protobuf.ByteString getBoundaryScannerLocaleBytes()
      optional string boundary_scanner_locale = 5 [json_name = "boundaryScannerLocale"];
      Returns:
      The bytes for boundaryScannerLocale.

    • hasForceSource

      boolean hasForceSource()
      optional bool force_source = 6 [json_name = "forceSource"];
      Returns:
      Whether the forceSource field is set.

    • getForceSource

      boolean getForceSource()
      optional bool force_source = 6 [json_name = "forceSource"];
      Returns:
      The forceSource.

    • hasFragmenter

      boolean hasFragmenter()
      optional .org.opensearch.protobufs.HighlighterFragmenter fragmenter = 7 [json_name = "fragmenter"];
      Returns:
      Whether the fragmenter field is set.

    • getFragmenterValue

      int getFragmenterValue()
      optional .org.opensearch.protobufs.HighlighterFragmenter fragmenter = 7 [json_name = "fragmenter"];
      Returns:
      The enum numeric value on the wire for fragmenter.

    • getFragmenter

      HighlighterFragmenter getFragmenter()
      optional .org.opensearch.protobufs.HighlighterFragmenter fragmenter = 7 [json_name = "fragmenter"];
      Returns:
      The fragmenter.

    • hasFragmentOffset

      boolean hasFragmentOffset()
      optional int32 fragment_offset = 8 [json_name = "fragmentOffset"];
      Returns:
      Whether the fragmentOffset field is set.

    • getFragmentOffset

      int getFragmentOffset()
      optional int32 fragment_offset = 8 [json_name = "fragmentOffset"];
      Returns:
      The fragmentOffset.

    • hasFragmentSize

      boolean hasFragmentSize()
      optional int32 fragment_size = 9 [json_name = "fragmentSize"];
      Returns:
      Whether the fragmentSize field is set.

    • getFragmentSize

      int getFragmentSize()
      optional int32 fragment_size = 9 [json_name = "fragmentSize"];
      Returns:
      The fragmentSize.

    • hasHighlightFilter

      boolean hasHighlightFilter()
      optional bool highlight_filter = 10 [json_name = "highlightFilter"];
      Returns:
      Whether the highlightFilter field is set.

    • getHighlightFilter

      boolean getHighlightFilter()
      optional bool highlight_filter = 10 [json_name = "highlightFilter"];
      Returns:
      The highlightFilter.

    • hasHighlightQuery

      boolean hasHighlightQuery()
      optional .org.opensearch.protobufs.QueryContainer highlight_query = 11 [json_name = "highlightQuery"];
      Returns:
      Whether the highlightQuery field is set.

    • getHighlightQuery

      QueryContainer getHighlightQuery()
      optional .org.opensearch.protobufs.QueryContainer highlight_query = 11 [json_name = "highlightQuery"];
      Returns:
      The highlightQuery.

    • getHighlightQueryOrBuilder

      QueryContainerOrBuilder getHighlightQueryOrBuilder()
      optional .org.opensearch.protobufs.QueryContainer highlight_query = 11 [json_name = "highlightQuery"];

    • hasMaxFragmentLength

      boolean hasMaxFragmentLength()
      optional int32 max_fragment_length = 12 [json_name = "maxFragmentLength"];
      Returns:
      Whether the maxFragmentLength field is set.

    • getMaxFragmentLength

      int getMaxFragmentLength()
      optional int32 max_fragment_length = 12 [json_name = "maxFragmentLength"];
      Returns:
      The maxFragmentLength.

    • hasMaxAnalyzerOffset

      boolean hasMaxAnalyzerOffset()
      optional int32 max_analyzer_offset = 13 [json_name = "maxAnalyzerOffset"];
      Returns:
      Whether the maxAnalyzerOffset field is set.

    • getMaxAnalyzerOffset

      int getMaxAnalyzerOffset()
      optional int32 max_analyzer_offset = 13 [json_name = "maxAnalyzerOffset"];
      Returns:
      The maxAnalyzerOffset.

    • hasNoMatchSize

      boolean hasNoMatchSize()
      optional int32 no_match_size = 14 [json_name = "noMatchSize"];
      Returns:
      Whether the noMatchSize field is set.

    • getNoMatchSize

      int getNoMatchSize()
      optional int32 no_match_size = 14 [json_name = "noMatchSize"];
      Returns:
      The noMatchSize.

    • hasNumberOfFragments

      boolean hasNumberOfFragments()
      optional int32 number_of_fragments = 15 [json_name = "numberOfFragments"];
      Returns:
      Whether the numberOfFragments field is set.

    • getNumberOfFragments

      int getNumberOfFragments()
      optional int32 number_of_fragments = 15 [json_name = "numberOfFragments"];
      Returns:
      The numberOfFragments.

    • hasOptions

      boolean hasOptions()
      optional .org.opensearch.protobufs.ObjectMap options = 16 [json_name = "options"];
      Returns:
      Whether the options field is set.

    • getOptions

      ObjectMap getOptions()
      optional .org.opensearch.protobufs.ObjectMap options = 16 [json_name = "options"];
      Returns:
      The options.

    • getOptionsOrBuilder

      ObjectMapOrBuilder getOptionsOrBuilder()
      optional .org.opensearch.protobufs.ObjectMap options = 16 [json_name = "options"];

    • hasOrder

      boolean hasOrder()
      optional .org.opensearch.protobufs.HighlighterOrder order = 17 [json_name = "order"];
      Returns:
      Whether the order field is set.

    • getOrderValue

      int getOrderValue()
      optional .org.opensearch.protobufs.HighlighterOrder order = 17 [json_name = "order"];
      Returns:
      The enum numeric value on the wire for order.

    • getOrder

      HighlighterOrder getOrder()
      optional .org.opensearch.protobufs.HighlighterOrder order = 17 [json_name = "order"];
      Returns:
      The order.

    • hasPhraseLimit

      boolean hasPhraseLimit()
      optional int32 phrase_limit = 18 [json_name = "phraseLimit"];
      Returns:
      Whether the phraseLimit field is set.

    • getPhraseLimit

      int getPhraseLimit()
      optional int32 phrase_limit = 18 [json_name = "phraseLimit"];
      Returns:
      The phraseLimit.

    • getPostTagsList

      List<String> getPostTagsList()
      repeated string post_tags = 19 [json_name = "postTags"];
      Returns:
      A list containing the postTags.

    • getPostTagsCount

      int getPostTagsCount()
      repeated string post_tags = 19 [json_name = "postTags"];
      Returns:
      The count of postTags.

    • getPostTags

      String getPostTags(int index)
      repeated string post_tags = 19 [json_name = "postTags"];
      Parameters:
      index - The index of the element to return.
      Returns:
      The postTags at the given index.

    • getPostTagsBytes

      com.google.protobuf.ByteString getPostTagsBytes(int index)
      repeated string post_tags = 19 [json_name = "postTags"];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the postTags at the given index.

    • getPreTagsList

      List<String> getPreTagsList()
      repeated string pre_tags = 20 [json_name = "preTags"];
      Returns:
      A list containing the preTags.

    • getPreTagsCount

      int getPreTagsCount()
      repeated string pre_tags = 20 [json_name = "preTags"];
      Returns:
      The count of preTags.

    • getPreTags

      String getPreTags(int index)
      repeated string pre_tags = 20 [json_name = "preTags"];
      Parameters:
      index - The index of the element to return.
      Returns:
      The preTags at the given index.

    • getPreTagsBytes

      com.google.protobuf.ByteString getPreTagsBytes(int index)
      repeated string pre_tags = 20 [json_name = "preTags"];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the preTags at the given index.

    • hasRequireFieldMatch

      boolean hasRequireFieldMatch()
      optional bool require_field_match = 21 [json_name = "requireFieldMatch"];
      Returns:
      Whether the requireFieldMatch field is set.

    • getRequireFieldMatch

      boolean getRequireFieldMatch()
      optional bool require_field_match = 21 [json_name = "requireFieldMatch"];
      Returns:
      The requireFieldMatch.

    • hasTagsSchema

      boolean hasTagsSchema()
      optional .org.opensearch.protobufs.HighlighterTagsSchema tags_schema = 22 [json_name = "tagsSchema"];
      Returns:
      Whether the tagsSchema field is set.

    • getTagsSchemaValue

      int getTagsSchemaValue()
      optional .org.opensearch.protobufs.HighlighterTagsSchema tags_schema = 22 [json_name = "tagsSchema"];
      Returns:
      The enum numeric value on the wire for tagsSchema.

    • getTagsSchema

      HighlighterTagsSchema getTagsSchema()
      optional .org.opensearch.protobufs.HighlighterTagsSchema tags_schema = 22 [json_name = "tagsSchema"];
      Returns:
      The tagsSchema.

    • hasEncoder

      boolean hasEncoder()
      optional .org.opensearch.protobufs.HighlighterEncoder encoder = 23 [json_name = "encoder"];
      Returns:
      Whether the encoder field is set.

    • getEncoderValue

      int getEncoderValue()
      optional .org.opensearch.protobufs.HighlighterEncoder encoder = 23 [json_name = "encoder"];
      Returns:
      The enum numeric value on the wire for encoder.

    • getEncoder

      HighlighterEncoder getEncoder()
      optional .org.opensearch.protobufs.HighlighterEncoder encoder = 23 [json_name = "encoder"];
      Returns:
      The encoder.

    • getFieldsCount

      int getFieldsCount()
      map<string, .org.opensearch.protobufs.HighlightField> fields = 24 [json_name = "fields"];

    • containsFields

      boolean containsFields(String key)
      map<string, .org.opensearch.protobufs.HighlightField> fields = 24 [json_name = "fields"];

    • getFields

      @Deprecated Map<String,HighlightField> getFields()
      Deprecated.
      Use getFieldsMap() instead.

    • getFieldsMap

      Map<String,HighlightField> getFieldsMap()
      map<string, .org.opensearch.protobufs.HighlightField> fields = 24 [json_name = "fields"];

    • getFieldsOrDefault

      HighlightField getFieldsOrDefault(String key, HighlightField defaultValue)
      map<string, .org.opensearch.protobufs.HighlightField> fields = 24 [json_name = "fields"];

    • getFieldsOrThrow

      HighlightField getFieldsOrThrow(String key)
      map<string, .org.opensearch.protobufs.HighlightField> fields = 24 [json_name = "fields"];