Package org.opensearch.protobufs

Class Highlight

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.opensearch.protobufs.Highlight
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, HighlightOrBuilder
public final class Highlight extends com.google.protobuf.GeneratedMessageV3 implements HighlightOrBuilder
Protobuf type org.opensearch.protobufs.Highlight
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Highlight.Builder
    Protobuf type org.opensearch.protobufs.Highlight

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    BOUNDARY_CHARS_FIELD_NUMBER
     
    static final int
    BOUNDARY_MAX_SCAN_FIELD_NUMBER
     
    static final int
    BOUNDARY_SCANNER_FIELD_NUMBER
     
    static final int
    BOUNDARY_SCANNER_LOCALE_FIELD_NUMBER
     
    static final int
    ENCODER_FIELD_NUMBER
     
    static final int
    FIELDS_FIELD_NUMBER
     
    static final int
    FORCE_SOURCE_FIELD_NUMBER
     
    static final int
    FRAGMENT_OFFSET_FIELD_NUMBER
     
    static final int
    FRAGMENT_SIZE_FIELD_NUMBER
     
    static final int
    FRAGMENTER_FIELD_NUMBER
     
    static final int
    HIGHLIGHT_FILTER_FIELD_NUMBER
     
    static final int
    HIGHLIGHT_QUERY_FIELD_NUMBER
     
    static final int
    MAX_ANALYZER_OFFSET_FIELD_NUMBER
     
    static final int
    MAX_FRAGMENT_LENGTH_FIELD_NUMBER
     
    static final int
    NO_MATCH_SIZE_FIELD_NUMBER
     
    static final int
    NUMBER_OF_FRAGMENTS_FIELD_NUMBER
     
    static final int
    OPTIONS_FIELD_NUMBER
     
    static final int
    ORDER_FIELD_NUMBER
     
    static final int
    PHRASE_LIMIT_FIELD_NUMBER
     
    static final int
    POST_TAGS_FIELD_NUMBER
     
    static final int
    PRE_TAGS_FIELD_NUMBER
     
    static final int
    REQUIRE_FIELD_MATCH_FIELD_NUMBER
     
    static final int
    TAGS_SCHEMA_FIELD_NUMBER
     
    static final int
    TYPE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsFields(String key)
    map<string, .org.opensearch.protobufs.HighlightField> fields = 24 [json_name = "fields"];
    boolean
    equals(Object obj)
     
    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"];
    static Highlight
    getDefaultInstance()
     
    Highlight
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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"];
    com.google.protobuf.Parser<Highlight>
    getParserForType()
     
    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"];
    com.google.protobuf.ProtocolStringList
    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"];
    com.google.protobuf.ProtocolStringList
    getPreTagsList()
    repeated string pre_tags = 20 [json_name = "preTags"];
    boolean
    getRequireFieldMatch()
    optional bool require_field_match = 21 [json_name = "requireFieldMatch"];
    int
    getSerializedSize()
     
    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"];
    int
    hashCode()
     
    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"];
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    protected com.google.protobuf.MapFieldReflectionAccessor
    internalGetMapFieldReflection(int number)
     
    final boolean
    isInitialized()
     
    static Highlight.Builder
    newBuilder()
     
    static Highlight.Builder
    newBuilder(Highlight prototype)
     
    Highlight.Builder
    newBuilderForType()
     
    protected Highlight.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Highlight
    parseDelimitedFrom(InputStream input)
     
    static Highlight
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Highlight
    parseFrom(byte[] data)
     
    static Highlight
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Highlight
    parseFrom(com.google.protobuf.ByteString data)
     
    static Highlight
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Highlight
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Highlight
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Highlight
    parseFrom(InputStream input)
     
    static Highlight
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Highlight
    parseFrom(ByteBuffer data)
     
    static Highlight
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Highlight>
    parser()
     
    Highlight.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • TYPE_FIELD_NUMBER

      public static final int TYPE_FIELD_NUMBER
      See Also:

    • BOUNDARY_CHARS_FIELD_NUMBER

      public static final int BOUNDARY_CHARS_FIELD_NUMBER
      See Also:

    • BOUNDARY_MAX_SCAN_FIELD_NUMBER

      public static final int BOUNDARY_MAX_SCAN_FIELD_NUMBER
      See Also:

    • BOUNDARY_SCANNER_FIELD_NUMBER

      public static final int BOUNDARY_SCANNER_FIELD_NUMBER
      See Also:

    • BOUNDARY_SCANNER_LOCALE_FIELD_NUMBER

      public static final int BOUNDARY_SCANNER_LOCALE_FIELD_NUMBER
      See Also:

    • FORCE_SOURCE_FIELD_NUMBER

      public static final int FORCE_SOURCE_FIELD_NUMBER
      See Also:

    • FRAGMENTER_FIELD_NUMBER

      public static final int FRAGMENTER_FIELD_NUMBER
      See Also:

    • FRAGMENT_OFFSET_FIELD_NUMBER

      public static final int FRAGMENT_OFFSET_FIELD_NUMBER
      See Also:

    • FRAGMENT_SIZE_FIELD_NUMBER

      public static final int FRAGMENT_SIZE_FIELD_NUMBER
      See Also:

    • HIGHLIGHT_FILTER_FIELD_NUMBER

      public static final int HIGHLIGHT_FILTER_FIELD_NUMBER
      See Also:

    • HIGHLIGHT_QUERY_FIELD_NUMBER

      public static final int HIGHLIGHT_QUERY_FIELD_NUMBER
      See Also:

    • MAX_FRAGMENT_LENGTH_FIELD_NUMBER

      public static final int MAX_FRAGMENT_LENGTH_FIELD_NUMBER
      See Also:

    • MAX_ANALYZER_OFFSET_FIELD_NUMBER

      public static final int MAX_ANALYZER_OFFSET_FIELD_NUMBER
      See Also:

    • NO_MATCH_SIZE_FIELD_NUMBER

      public static final int NO_MATCH_SIZE_FIELD_NUMBER
      See Also:

    • NUMBER_OF_FRAGMENTS_FIELD_NUMBER

      public static final int NUMBER_OF_FRAGMENTS_FIELD_NUMBER
      See Also:

    • OPTIONS_FIELD_NUMBER

      public static final int OPTIONS_FIELD_NUMBER
      See Also:

    • ORDER_FIELD_NUMBER

      public static final int ORDER_FIELD_NUMBER
      See Also:

    • PHRASE_LIMIT_FIELD_NUMBER

      public static final int PHRASE_LIMIT_FIELD_NUMBER
      See Also:

    • POST_TAGS_FIELD_NUMBER

      public static final int POST_TAGS_FIELD_NUMBER
      See Also:

    • PRE_TAGS_FIELD_NUMBER

      public static final int PRE_TAGS_FIELD_NUMBER
      See Also:

    • REQUIRE_FIELD_MATCH_FIELD_NUMBER

      public static final int REQUIRE_FIELD_MATCH_FIELD_NUMBER
      See Also:

    • TAGS_SCHEMA_FIELD_NUMBER

      public static final int TAGS_SCHEMA_FIELD_NUMBER
      See Also:

    • ENCODER_FIELD_NUMBER

      public static final int ENCODER_FIELD_NUMBER
      See Also:

    • FIELDS_FIELD_NUMBER

      public static final int FIELDS_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • hasType

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

    • getType

      public HighlighterType getType()
      optional .org.opensearch.protobufs.HighlighterType type = 1 [json_name = "type"];
      Specified by:
      getType in interface HighlightOrBuilder
      Returns:
      The type.

    • getTypeOrBuilder

      public HighlighterTypeOrBuilder getTypeOrBuilder()
      optional .org.opensearch.protobufs.HighlighterType type = 1 [json_name = "type"];
      Specified by:
      getTypeOrBuilder in interface HighlightOrBuilder

    • hasBoundaryChars

      public boolean hasBoundaryChars()
      optional string boundary_chars = 2 [json_name = "boundaryChars"];
      Specified by:
      hasBoundaryChars in interface HighlightOrBuilder
      Returns:
      Whether the boundaryChars field is set.

    • getBoundaryChars

      public String getBoundaryChars()
      optional string boundary_chars = 2 [json_name = "boundaryChars"];
      Specified by:
      getBoundaryChars in interface HighlightOrBuilder
      Returns:
      The boundaryChars.

    • getBoundaryCharsBytes

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

    • hasBoundaryMaxScan

      public boolean hasBoundaryMaxScan()
      optional int32 boundary_max_scan = 3 [json_name = "boundaryMaxScan"];
      Specified by:
      hasBoundaryMaxScan in interface HighlightOrBuilder
      Returns:
      Whether the boundaryMaxScan field is set.

    • getBoundaryMaxScan

      public int getBoundaryMaxScan()
      optional int32 boundary_max_scan = 3 [json_name = "boundaryMaxScan"];
      Specified by:
      getBoundaryMaxScan in interface HighlightOrBuilder
      Returns:
      The boundaryMaxScan.

    • hasBoundaryScanner

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

    • getBoundaryScannerValue

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

    • getBoundaryScanner

      public BoundaryScanner getBoundaryScanner()
      optional .org.opensearch.protobufs.BoundaryScanner boundary_scanner = 4 [json_name = "boundaryScanner"];
      Specified by:
      getBoundaryScanner in interface HighlightOrBuilder
      Returns:
      The boundaryScanner.

    • hasBoundaryScannerLocale

      public boolean hasBoundaryScannerLocale()
      optional string boundary_scanner_locale = 5 [json_name = "boundaryScannerLocale"];
      Specified by:
      hasBoundaryScannerLocale in interface HighlightOrBuilder
      Returns:
      Whether the boundaryScannerLocale field is set.

    • getBoundaryScannerLocale

      public String getBoundaryScannerLocale()
      optional string boundary_scanner_locale = 5 [json_name = "boundaryScannerLocale"];
      Specified by:
      getBoundaryScannerLocale in interface HighlightOrBuilder
      Returns:
      The boundaryScannerLocale.

    • getBoundaryScannerLocaleBytes

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

    • hasForceSource

      public boolean hasForceSource()
      optional bool force_source = 6 [json_name = "forceSource"];
      Specified by:
      hasForceSource in interface HighlightOrBuilder
      Returns:
      Whether the forceSource field is set.

    • getForceSource

      public boolean getForceSource()
      optional bool force_source = 6 [json_name = "forceSource"];
      Specified by:
      getForceSource in interface HighlightOrBuilder
      Returns:
      The forceSource.

    • hasFragmenter

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

    • getFragmenterValue

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

    • getFragmenter

      public HighlighterFragmenter getFragmenter()
      optional .org.opensearch.protobufs.HighlighterFragmenter fragmenter = 7 [json_name = "fragmenter"];
      Specified by:
      getFragmenter in interface HighlightOrBuilder
      Returns:
      The fragmenter.

    • hasFragmentOffset

      public boolean hasFragmentOffset()
      optional int32 fragment_offset = 8 [json_name = "fragmentOffset"];
      Specified by:
      hasFragmentOffset in interface HighlightOrBuilder
      Returns:
      Whether the fragmentOffset field is set.

    • getFragmentOffset

      public int getFragmentOffset()
      optional int32 fragment_offset = 8 [json_name = "fragmentOffset"];
      Specified by:
      getFragmentOffset in interface HighlightOrBuilder
      Returns:
      The fragmentOffset.

    • hasFragmentSize

      public boolean hasFragmentSize()
      optional int32 fragment_size = 9 [json_name = "fragmentSize"];
      Specified by:
      hasFragmentSize in interface HighlightOrBuilder
      Returns:
      Whether the fragmentSize field is set.

    • getFragmentSize

      public int getFragmentSize()
      optional int32 fragment_size = 9 [json_name = "fragmentSize"];
      Specified by:
      getFragmentSize in interface HighlightOrBuilder
      Returns:
      The fragmentSize.

    • hasHighlightFilter

      public boolean hasHighlightFilter()
      optional bool highlight_filter = 10 [json_name = "highlightFilter"];
      Specified by:
      hasHighlightFilter in interface HighlightOrBuilder
      Returns:
      Whether the highlightFilter field is set.

    • getHighlightFilter

      public boolean getHighlightFilter()
      optional bool highlight_filter = 10 [json_name = "highlightFilter"];
      Specified by:
      getHighlightFilter in interface HighlightOrBuilder
      Returns:
      The highlightFilter.

    • hasHighlightQuery

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

    • getHighlightQuery

      public QueryContainer getHighlightQuery()
      optional .org.opensearch.protobufs.QueryContainer highlight_query = 11 [json_name = "highlightQuery"];
      Specified by:
      getHighlightQuery in interface HighlightOrBuilder
      Returns:
      The highlightQuery.

    • getHighlightQueryOrBuilder

      public QueryContainerOrBuilder getHighlightQueryOrBuilder()
      optional .org.opensearch.protobufs.QueryContainer highlight_query = 11 [json_name = "highlightQuery"];
      Specified by:
      getHighlightQueryOrBuilder in interface HighlightOrBuilder

    • hasMaxFragmentLength

      public boolean hasMaxFragmentLength()
      optional int32 max_fragment_length = 12 [json_name = "maxFragmentLength"];
      Specified by:
      hasMaxFragmentLength in interface HighlightOrBuilder
      Returns:
      Whether the maxFragmentLength field is set.

    • getMaxFragmentLength

      public int getMaxFragmentLength()
      optional int32 max_fragment_length = 12 [json_name = "maxFragmentLength"];
      Specified by:
      getMaxFragmentLength in interface HighlightOrBuilder
      Returns:
      The maxFragmentLength.

    • hasMaxAnalyzerOffset

      public boolean hasMaxAnalyzerOffset()
      optional int32 max_analyzer_offset = 13 [json_name = "maxAnalyzerOffset"];
      Specified by:
      hasMaxAnalyzerOffset in interface HighlightOrBuilder
      Returns:
      Whether the maxAnalyzerOffset field is set.

    • getMaxAnalyzerOffset

      public int getMaxAnalyzerOffset()
      optional int32 max_analyzer_offset = 13 [json_name = "maxAnalyzerOffset"];
      Specified by:
      getMaxAnalyzerOffset in interface HighlightOrBuilder
      Returns:
      The maxAnalyzerOffset.

    • hasNoMatchSize

      public boolean hasNoMatchSize()
      optional int32 no_match_size = 14 [json_name = "noMatchSize"];
      Specified by:
      hasNoMatchSize in interface HighlightOrBuilder
      Returns:
      Whether the noMatchSize field is set.

    • getNoMatchSize

      public int getNoMatchSize()
      optional int32 no_match_size = 14 [json_name = "noMatchSize"];
      Specified by:
      getNoMatchSize in interface HighlightOrBuilder
      Returns:
      The noMatchSize.

    • hasNumberOfFragments

      public boolean hasNumberOfFragments()
      optional int32 number_of_fragments = 15 [json_name = "numberOfFragments"];
      Specified by:
      hasNumberOfFragments in interface HighlightOrBuilder
      Returns:
      Whether the numberOfFragments field is set.

    • getNumberOfFragments

      public int getNumberOfFragments()
      optional int32 number_of_fragments = 15 [json_name = "numberOfFragments"];
      Specified by:
      getNumberOfFragments in interface HighlightOrBuilder
      Returns:
      The numberOfFragments.

    • hasOptions

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

    • getOptions

      public ObjectMap getOptions()
      optional .org.opensearch.protobufs.ObjectMap options = 16 [json_name = "options"];
      Specified by:
      getOptions in interface HighlightOrBuilder
      Returns:
      The options.

    • getOptionsOrBuilder

      public ObjectMapOrBuilder getOptionsOrBuilder()
      optional .org.opensearch.protobufs.ObjectMap options = 16 [json_name = "options"];
      Specified by:
      getOptionsOrBuilder in interface HighlightOrBuilder

    • hasOrder

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

    • getOrderValue

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

    • getOrder

      public HighlighterOrder getOrder()
      optional .org.opensearch.protobufs.HighlighterOrder order = 17 [json_name = "order"];
      Specified by:
      getOrder in interface HighlightOrBuilder
      Returns:
      The order.

    • hasPhraseLimit

      public boolean hasPhraseLimit()
      optional int32 phrase_limit = 18 [json_name = "phraseLimit"];
      Specified by:
      hasPhraseLimit in interface HighlightOrBuilder
      Returns:
      Whether the phraseLimit field is set.

    • getPhraseLimit

      public int getPhraseLimit()
      optional int32 phrase_limit = 18 [json_name = "phraseLimit"];
      Specified by:
      getPhraseLimit in interface HighlightOrBuilder
      Returns:
      The phraseLimit.

    • getPostTagsList

      public com.google.protobuf.ProtocolStringList getPostTagsList()
      repeated string post_tags = 19 [json_name = "postTags"];
      Specified by:
      getPostTagsList in interface HighlightOrBuilder
      Returns:
      A list containing the postTags.

    • getPostTagsCount

      public int getPostTagsCount()
      repeated string post_tags = 19 [json_name = "postTags"];
      Specified by:
      getPostTagsCount in interface HighlightOrBuilder
      Returns:
      The count of postTags.

    • getPostTags

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

    • getPostTagsBytes

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

    • getPreTagsList

      public com.google.protobuf.ProtocolStringList getPreTagsList()
      repeated string pre_tags = 20 [json_name = "preTags"];
      Specified by:
      getPreTagsList in interface HighlightOrBuilder
      Returns:
      A list containing the preTags.

    • getPreTagsCount

      public int getPreTagsCount()
      repeated string pre_tags = 20 [json_name = "preTags"];
      Specified by:
      getPreTagsCount in interface HighlightOrBuilder
      Returns:
      The count of preTags.

    • getPreTags

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

    • getPreTagsBytes

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

    • hasRequireFieldMatch

      public boolean hasRequireFieldMatch()
      optional bool require_field_match = 21 [json_name = "requireFieldMatch"];
      Specified by:
      hasRequireFieldMatch in interface HighlightOrBuilder
      Returns:
      Whether the requireFieldMatch field is set.

    • getRequireFieldMatch

      public boolean getRequireFieldMatch()
      optional bool require_field_match = 21 [json_name = "requireFieldMatch"];
      Specified by:
      getRequireFieldMatch in interface HighlightOrBuilder
      Returns:
      The requireFieldMatch.

    • hasTagsSchema

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

    • getTagsSchemaValue

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

    • getTagsSchema

      public HighlighterTagsSchema getTagsSchema()
      optional .org.opensearch.protobufs.HighlighterTagsSchema tags_schema = 22 [json_name = "tagsSchema"];
      Specified by:
      getTagsSchema in interface HighlightOrBuilder
      Returns:
      The tagsSchema.

    • hasEncoder

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

    • getEncoderValue

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

    • getEncoder

      public HighlighterEncoder getEncoder()
      optional .org.opensearch.protobufs.HighlighterEncoder encoder = 23 [json_name = "encoder"];
      Specified by:
      getEncoder in interface HighlightOrBuilder
      Returns:
      The encoder.

    • getFieldsCount

      public int getFieldsCount()
      Description copied from interface: HighlightOrBuilder
      map<string, .org.opensearch.protobufs.HighlightField> fields = 24 [json_name = "fields"];
      Specified by:
      getFieldsCount in interface HighlightOrBuilder

    • containsFields

      public boolean containsFields(String key)
      map<string, .org.opensearch.protobufs.HighlightField> fields = 24 [json_name = "fields"];
      Specified by:
      containsFields in interface HighlightOrBuilder

    • getFields

      @Deprecated public Map<String,HighlightField> getFields()
      Deprecated.
      Use getFieldsMap() instead.
      Specified by:
      getFields in interface HighlightOrBuilder

    • getFieldsMap

      public Map<String,HighlightField> getFieldsMap()
      map<string, .org.opensearch.protobufs.HighlightField> fields = 24 [json_name = "fields"];
      Specified by:
      getFieldsMap in interface HighlightOrBuilder

    • getFieldsOrDefault

      public HighlightField getFieldsOrDefault(String key, HighlightField defaultValue)
      map<string, .org.opensearch.protobufs.HighlightField> fields = 24 [json_name = "fields"];
      Specified by:
      getFieldsOrDefault in interface HighlightOrBuilder

    • getFieldsOrThrow

      public HighlightField getFieldsOrThrow(String key)
      map<string, .org.opensearch.protobufs.HighlightField> fields = 24 [json_name = "fields"];
      Specified by:
      getFieldsOrThrow in interface HighlightOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Highlight parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Highlight parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Highlight parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Highlight parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Highlight parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Highlight parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Highlight parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Highlight parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Highlight parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Highlight parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Highlight parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Highlight parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Highlight.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Highlight.Builder newBuilder()

    • newBuilder

      public static Highlight.Builder newBuilder(Highlight prototype)

    • toBuilder

      public Highlight.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Highlight.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static Highlight getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Highlight> parser()

    • getParserForType

      public com.google.protobuf.Parser<Highlight> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public Highlight getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder