Package org.opensearch.protobufs

Class HighlightField.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<HighlightField.Builder>
com.google.protobuf.GeneratedMessageV3.Builder<HighlightField.Builder>
org.opensearch.protobufs.HighlightField.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, HighlightFieldOrBuilder
Enclosing class:
HighlightField
public static final class HighlightField.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<HighlightField.Builder> implements HighlightFieldOrBuilder
Protobuf type org.opensearch.protobufs.HighlightField

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<HighlightField.Builder>

    • clear

      public HighlightField.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<HighlightField.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<HighlightField.Builder>

    • getDefaultInstanceForType

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

    • build

      public HighlightField build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public HighlightField buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • clone

      public HighlightField.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<HighlightField.Builder>

    • setField

      public HighlightField.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<HighlightField.Builder>

    • clearField

      public HighlightField.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<HighlightField.Builder>

    • clearOneof

      public HighlightField.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<HighlightField.Builder>

    • setRepeatedField

      public HighlightField.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<HighlightField.Builder>

    • addRepeatedField

      public HighlightField.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<HighlightField.Builder>

    • mergeFrom

      public HighlightField.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<HighlightField.Builder>

    • mergeFrom

      public HighlightField.Builder mergeFrom(HighlightField other)

    • isInitialized

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

    • mergeFrom

      public HighlightField.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<HighlightField.Builder>
      Throws:
      IOException

    • hasType

      public boolean hasType()
      optional .org.opensearch.protobufs.HighlighterType type = 1 [json_name = "type"];
      Specified by:
      hasType in interface HighlightFieldOrBuilder
      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 HighlightFieldOrBuilder
      Returns:
      The type.

    • setType

      public HighlightField.Builder setType(HighlighterType value)
      optional .org.opensearch.protobufs.HighlighterType type = 1 [json_name = "type"];

    • setType

      public HighlightField.Builder setType(HighlighterType.Builder builderForValue)
      optional .org.opensearch.protobufs.HighlighterType type = 1 [json_name = "type"];

    • mergeType

      public HighlightField.Builder mergeType(HighlighterType value)
      optional .org.opensearch.protobufs.HighlighterType type = 1 [json_name = "type"];

    • clearType

      public HighlightField.Builder clearType()
      optional .org.opensearch.protobufs.HighlighterType type = 1 [json_name = "type"];

    • getTypeBuilder

      public HighlighterType.Builder getTypeBuilder()
      optional .org.opensearch.protobufs.HighlighterType type = 1 [json_name = "type"];

    • getTypeOrBuilder

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

    • hasBoundaryChars

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

    • getBoundaryChars

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

    • getBoundaryCharsBytes

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

    • setBoundaryChars

      public HighlightField.Builder setBoundaryChars(String value)
      optional string boundary_chars = 2 [json_name = "boundaryChars"];
      Parameters:
      value - The boundaryChars to set.
      Returns:
      This builder for chaining.

    • clearBoundaryChars

      public HighlightField.Builder clearBoundaryChars()
      optional string boundary_chars = 2 [json_name = "boundaryChars"];
      Returns:
      This builder for chaining.

    • setBoundaryCharsBytes

      public HighlightField.Builder setBoundaryCharsBytes(com.google.protobuf.ByteString value)
      optional string boundary_chars = 2 [json_name = "boundaryChars"];
      Parameters:
      value - The bytes for boundaryChars to set.
      Returns:
      This builder for chaining.

    • hasBoundaryMaxScan

      public boolean hasBoundaryMaxScan()
      optional int32 boundary_max_scan = 3 [json_name = "boundaryMaxScan"];
      Specified by:
      hasBoundaryMaxScan in interface HighlightFieldOrBuilder
      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 HighlightFieldOrBuilder
      Returns:
      The boundaryMaxScan.

    • setBoundaryMaxScan

      public HighlightField.Builder setBoundaryMaxScan(int value)
      optional int32 boundary_max_scan = 3 [json_name = "boundaryMaxScan"];
      Parameters:
      value - The boundaryMaxScan to set.
      Returns:
      This builder for chaining.

    • clearBoundaryMaxScan

      public HighlightField.Builder clearBoundaryMaxScan()
      optional int32 boundary_max_scan = 3 [json_name = "boundaryMaxScan"];
      Returns:
      This builder for chaining.

    • hasBoundaryScanner

      public boolean hasBoundaryScanner()
      optional .org.opensearch.protobufs.BoundaryScanner boundary_scanner = 4 [json_name = "boundaryScanner"];
      Specified by:
      hasBoundaryScanner in interface HighlightFieldOrBuilder
      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 HighlightFieldOrBuilder
      Returns:
      The enum numeric value on the wire for boundaryScanner.

    • setBoundaryScannerValue

      public HighlightField.Builder setBoundaryScannerValue(int value)
      optional .org.opensearch.protobufs.BoundaryScanner boundary_scanner = 4 [json_name = "boundaryScanner"];
      Parameters:
      value - The enum numeric value on the wire for boundaryScanner to set.
      Returns:
      This builder for chaining.

    • getBoundaryScanner

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

    • setBoundaryScanner

      public HighlightField.Builder setBoundaryScanner(BoundaryScanner value)
      optional .org.opensearch.protobufs.BoundaryScanner boundary_scanner = 4 [json_name = "boundaryScanner"];
      Parameters:
      value - The boundaryScanner to set.
      Returns:
      This builder for chaining.

    • clearBoundaryScanner

      public HighlightField.Builder clearBoundaryScanner()
      optional .org.opensearch.protobufs.BoundaryScanner boundary_scanner = 4 [json_name = "boundaryScanner"];
      Returns:
      This builder for chaining.

    • hasBoundaryScannerLocale

      public boolean hasBoundaryScannerLocale()
      optional string boundary_scanner_locale = 5 [json_name = "boundaryScannerLocale"];
      Specified by:
      hasBoundaryScannerLocale in interface HighlightFieldOrBuilder
      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 HighlightFieldOrBuilder
      Returns:
      The boundaryScannerLocale.

    • getBoundaryScannerLocaleBytes

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

    • setBoundaryScannerLocale

      public HighlightField.Builder setBoundaryScannerLocale(String value)
      optional string boundary_scanner_locale = 5 [json_name = "boundaryScannerLocale"];
      Parameters:
      value - The boundaryScannerLocale to set.
      Returns:
      This builder for chaining.

    • clearBoundaryScannerLocale

      public HighlightField.Builder clearBoundaryScannerLocale()
      optional string boundary_scanner_locale = 5 [json_name = "boundaryScannerLocale"];
      Returns:
      This builder for chaining.

    • setBoundaryScannerLocaleBytes

      public HighlightField.Builder setBoundaryScannerLocaleBytes(com.google.protobuf.ByteString value)
      optional string boundary_scanner_locale = 5 [json_name = "boundaryScannerLocale"];
      Parameters:
      value - The bytes for boundaryScannerLocale to set.
      Returns:
      This builder for chaining.

    • hasForceSource

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

    • getForceSource

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

    • setForceSource

      public HighlightField.Builder setForceSource(boolean value)
      optional bool force_source = 6 [json_name = "forceSource"];
      Parameters:
      value - The forceSource to set.
      Returns:
      This builder for chaining.

    • clearForceSource

      public HighlightField.Builder clearForceSource()
      optional bool force_source = 6 [json_name = "forceSource"];
      Returns:
      This builder for chaining.

    • hasFragmenter

      public boolean hasFragmenter()
      optional .org.opensearch.protobufs.HighlighterFragmenter fragmenter = 7 [json_name = "fragmenter"];
      Specified by:
      hasFragmenter in interface HighlightFieldOrBuilder
      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 HighlightFieldOrBuilder
      Returns:
      The enum numeric value on the wire for fragmenter.

    • setFragmenterValue

      public HighlightField.Builder setFragmenterValue(int value)
      optional .org.opensearch.protobufs.HighlighterFragmenter fragmenter = 7 [json_name = "fragmenter"];
      Parameters:
      value - The enum numeric value on the wire for fragmenter to set.
      Returns:
      This builder for chaining.

    • getFragmenter

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

    • setFragmenter

      public HighlightField.Builder setFragmenter(HighlighterFragmenter value)
      optional .org.opensearch.protobufs.HighlighterFragmenter fragmenter = 7 [json_name = "fragmenter"];
      Parameters:
      value - The fragmenter to set.
      Returns:
      This builder for chaining.

    • clearFragmenter

      public HighlightField.Builder clearFragmenter()
      optional .org.opensearch.protobufs.HighlighterFragmenter fragmenter = 7 [json_name = "fragmenter"];
      Returns:
      This builder for chaining.

    • hasFragmentSize

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

    • getFragmentSize

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

    • setFragmentSize

      public HighlightField.Builder setFragmentSize(int value)
      optional int32 fragment_size = 8 [json_name = "fragmentSize"];
      Parameters:
      value - The fragmentSize to set.
      Returns:
      This builder for chaining.

    • clearFragmentSize

      public HighlightField.Builder clearFragmentSize()
      optional int32 fragment_size = 8 [json_name = "fragmentSize"];
      Returns:
      This builder for chaining.

    • hasHighlightFilter

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

    • getHighlightFilter

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

    • setHighlightFilter

      public HighlightField.Builder setHighlightFilter(boolean value)
      optional bool highlight_filter = 9 [json_name = "highlightFilter"];
      Parameters:
      value - The highlightFilter to set.
      Returns:
      This builder for chaining.

    • clearHighlightFilter

      public HighlightField.Builder clearHighlightFilter()
      optional bool highlight_filter = 9 [json_name = "highlightFilter"];
      Returns:
      This builder for chaining.

    • hasHighlightQuery

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

    • getHighlightQuery

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

    • setHighlightQuery

      public HighlightField.Builder setHighlightQuery(QueryContainer value)
      optional .org.opensearch.protobufs.QueryContainer highlight_query = 10 [json_name = "highlightQuery"];

    • setHighlightQuery

      public HighlightField.Builder setHighlightQuery(QueryContainer.Builder builderForValue)
      optional .org.opensearch.protobufs.QueryContainer highlight_query = 10 [json_name = "highlightQuery"];

    • mergeHighlightQuery

      public HighlightField.Builder mergeHighlightQuery(QueryContainer value)
      optional .org.opensearch.protobufs.QueryContainer highlight_query = 10 [json_name = "highlightQuery"];

    • clearHighlightQuery

      public HighlightField.Builder clearHighlightQuery()
      optional .org.opensearch.protobufs.QueryContainer highlight_query = 10 [json_name = "highlightQuery"];

    • getHighlightQueryBuilder

      public QueryContainer.Builder getHighlightQueryBuilder()
      optional .org.opensearch.protobufs.QueryContainer highlight_query = 10 [json_name = "highlightQuery"];

    • getHighlightQueryOrBuilder

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

    • hasMaxFragmentLength

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

    • getMaxFragmentLength

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

    • setMaxFragmentLength

      public HighlightField.Builder setMaxFragmentLength(int value)
      optional int32 max_fragment_length = 11 [json_name = "maxFragmentLength"];
      Parameters:
      value - The maxFragmentLength to set.
      Returns:
      This builder for chaining.

    • clearMaxFragmentLength

      public HighlightField.Builder clearMaxFragmentLength()
      optional int32 max_fragment_length = 11 [json_name = "maxFragmentLength"];
      Returns:
      This builder for chaining.

    • hasMaxAnalyzerOffset

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

    • getMaxAnalyzerOffset

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

    • setMaxAnalyzerOffset

      public HighlightField.Builder setMaxAnalyzerOffset(int value)
      optional int32 max_analyzer_offset = 12 [json_name = "maxAnalyzerOffset"];
      Parameters:
      value - The maxAnalyzerOffset to set.
      Returns:
      This builder for chaining.

    • clearMaxAnalyzerOffset

      public HighlightField.Builder clearMaxAnalyzerOffset()
      optional int32 max_analyzer_offset = 12 [json_name = "maxAnalyzerOffset"];
      Returns:
      This builder for chaining.

    • hasNoMatchSize

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

    • getNoMatchSize

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

    • setNoMatchSize

      public HighlightField.Builder setNoMatchSize(int value)
      optional int32 no_match_size = 13 [json_name = "noMatchSize"];
      Parameters:
      value - The noMatchSize to set.
      Returns:
      This builder for chaining.

    • clearNoMatchSize

      public HighlightField.Builder clearNoMatchSize()
      optional int32 no_match_size = 13 [json_name = "noMatchSize"];
      Returns:
      This builder for chaining.

    • hasNumberOfFragments

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

    • getNumberOfFragments

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

    • setNumberOfFragments

      public HighlightField.Builder setNumberOfFragments(int value)
      optional int32 number_of_fragments = 14 [json_name = "numberOfFragments"];
      Parameters:
      value - The numberOfFragments to set.
      Returns:
      This builder for chaining.

    • clearNumberOfFragments

      public HighlightField.Builder clearNumberOfFragments()
      optional int32 number_of_fragments = 14 [json_name = "numberOfFragments"];
      Returns:
      This builder for chaining.

    • hasOptions

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

    • getOptions

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

    • setOptions

      public HighlightField.Builder setOptions(ObjectMap value)
      optional .org.opensearch.protobufs.ObjectMap options = 15 [json_name = "options"];

    • setOptions

      public HighlightField.Builder setOptions(ObjectMap.Builder builderForValue)
      optional .org.opensearch.protobufs.ObjectMap options = 15 [json_name = "options"];

    • mergeOptions

      public HighlightField.Builder mergeOptions(ObjectMap value)
      optional .org.opensearch.protobufs.ObjectMap options = 15 [json_name = "options"];

    • clearOptions

      public HighlightField.Builder clearOptions()
      optional .org.opensearch.protobufs.ObjectMap options = 15 [json_name = "options"];

    • getOptionsBuilder

      public ObjectMap.Builder getOptionsBuilder()
      optional .org.opensearch.protobufs.ObjectMap options = 15 [json_name = "options"];

    • getOptionsOrBuilder

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

    • hasOrder

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

    • getOrderValue

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

    • setOrderValue

      public HighlightField.Builder setOrderValue(int value)
      optional .org.opensearch.protobufs.HighlighterOrder order = 16 [json_name = "order"];
      Parameters:
      value - The enum numeric value on the wire for order to set.
      Returns:
      This builder for chaining.

    • getOrder

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

    • setOrder

      public HighlightField.Builder setOrder(HighlighterOrder value)
      optional .org.opensearch.protobufs.HighlighterOrder order = 16 [json_name = "order"];
      Parameters:
      value - The order to set.
      Returns:
      This builder for chaining.

    • clearOrder

      public HighlightField.Builder clearOrder()
      optional .org.opensearch.protobufs.HighlighterOrder order = 16 [json_name = "order"];
      Returns:
      This builder for chaining.

    • hasPhraseLimit

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

    • getPhraseLimit

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

    • setPhraseLimit

      public HighlightField.Builder setPhraseLimit(int value)
      optional int32 phrase_limit = 17 [json_name = "phraseLimit"];
      Parameters:
      value - The phraseLimit to set.
      Returns:
      This builder for chaining.

    • clearPhraseLimit

      public HighlightField.Builder clearPhraseLimit()
      optional int32 phrase_limit = 17 [json_name = "phraseLimit"];
      Returns:
      This builder for chaining.

    • getPostTagsList

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

    • getPostTagsCount

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

    • getPostTags

      public String getPostTags(int index)
      repeated string post_tags = 18 [json_name = "postTags"];
      Specified by:
      getPostTags in interface HighlightFieldOrBuilder
      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 = 18 [json_name = "postTags"];
      Specified by:
      getPostTagsBytes in interface HighlightFieldOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the postTags at the given index.

    • setPostTags

      public HighlightField.Builder setPostTags(int index, String value)
      repeated string post_tags = 18 [json_name = "postTags"];
      Parameters:
      index - The index to set the value at.
      value - The postTags to set.
      Returns:
      This builder for chaining.

    • addPostTags

      public HighlightField.Builder addPostTags(String value)
      repeated string post_tags = 18 [json_name = "postTags"];
      Parameters:
      value - The postTags to add.
      Returns:
      This builder for chaining.

    • addAllPostTags

      public HighlightField.Builder addAllPostTags(Iterable<String> values)
      repeated string post_tags = 18 [json_name = "postTags"];
      Parameters:
      values - The postTags to add.
      Returns:
      This builder for chaining.

    • clearPostTags

      public HighlightField.Builder clearPostTags()
      repeated string post_tags = 18 [json_name = "postTags"];
      Returns:
      This builder for chaining.

    • addPostTagsBytes

      public HighlightField.Builder addPostTagsBytes(com.google.protobuf.ByteString value)
      repeated string post_tags = 18 [json_name = "postTags"];
      Parameters:
      value - The bytes of the postTags to add.
      Returns:
      This builder for chaining.

    • getPreTagsList

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

    • getPreTagsCount

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

    • getPreTags

      public String getPreTags(int index)
      repeated string pre_tags = 19 [json_name = "preTags"];
      Specified by:
      getPreTags in interface HighlightFieldOrBuilder
      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 = 19 [json_name = "preTags"];
      Specified by:
      getPreTagsBytes in interface HighlightFieldOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the preTags at the given index.

    • setPreTags

      public HighlightField.Builder setPreTags(int index, String value)
      repeated string pre_tags = 19 [json_name = "preTags"];
      Parameters:
      index - The index to set the value at.
      value - The preTags to set.
      Returns:
      This builder for chaining.

    • addPreTags

      public HighlightField.Builder addPreTags(String value)
      repeated string pre_tags = 19 [json_name = "preTags"];
      Parameters:
      value - The preTags to add.
      Returns:
      This builder for chaining.

    • addAllPreTags

      public HighlightField.Builder addAllPreTags(Iterable<String> values)
      repeated string pre_tags = 19 [json_name = "preTags"];
      Parameters:
      values - The preTags to add.
      Returns:
      This builder for chaining.

    • clearPreTags

      public HighlightField.Builder clearPreTags()
      repeated string pre_tags = 19 [json_name = "preTags"];
      Returns:
      This builder for chaining.

    • addPreTagsBytes

      public HighlightField.Builder addPreTagsBytes(com.google.protobuf.ByteString value)
      repeated string pre_tags = 19 [json_name = "preTags"];
      Parameters:
      value - The bytes of the preTags to add.
      Returns:
      This builder for chaining.

    • hasRequireFieldMatch

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

    • getRequireFieldMatch

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

    • setRequireFieldMatch

      public HighlightField.Builder setRequireFieldMatch(boolean value)
      optional bool require_field_match = 20 [json_name = "requireFieldMatch"];
      Parameters:
      value - The requireFieldMatch to set.
      Returns:
      This builder for chaining.

    • clearRequireFieldMatch

      public HighlightField.Builder clearRequireFieldMatch()
      optional bool require_field_match = 20 [json_name = "requireFieldMatch"];
      Returns:
      This builder for chaining.

    • hasTagsSchema

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

    • getTagsSchemaValue

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

    • setTagsSchemaValue

      public HighlightField.Builder setTagsSchemaValue(int value)
      optional .org.opensearch.protobufs.HighlighterTagsSchema tags_schema = 21 [json_name = "tagsSchema"];
      Parameters:
      value - The enum numeric value on the wire for tagsSchema to set.
      Returns:
      This builder for chaining.

    • getTagsSchema

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

    • setTagsSchema

      public HighlightField.Builder setTagsSchema(HighlighterTagsSchema value)
      optional .org.opensearch.protobufs.HighlighterTagsSchema tags_schema = 21 [json_name = "tagsSchema"];
      Parameters:
      value - The tagsSchema to set.
      Returns:
      This builder for chaining.

    • clearTagsSchema

      public HighlightField.Builder clearTagsSchema()
      optional .org.opensearch.protobufs.HighlighterTagsSchema tags_schema = 21 [json_name = "tagsSchema"];
      Returns:
      This builder for chaining.

    • hasFragmentOffset

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

    • getFragmentOffset

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

    • setFragmentOffset

      public HighlightField.Builder setFragmentOffset(int value)
      optional int32 fragment_offset = 22 [json_name = "fragmentOffset"];
      Parameters:
      value - The fragmentOffset to set.
      Returns:
      This builder for chaining.

    • clearFragmentOffset

      public HighlightField.Builder clearFragmentOffset()
      optional int32 fragment_offset = 22 [json_name = "fragmentOffset"];
      Returns:
      This builder for chaining.

    • getMatchedFieldsList

      public com.google.protobuf.ProtocolStringList getMatchedFieldsList()
      repeated string matched_fields = 23 [json_name = "matchedFields"];
      Specified by:
      getMatchedFieldsList in interface HighlightFieldOrBuilder
      Returns:
      A list containing the matchedFields.

    • getMatchedFieldsCount

      public int getMatchedFieldsCount()
      repeated string matched_fields = 23 [json_name = "matchedFields"];
      Specified by:
      getMatchedFieldsCount in interface HighlightFieldOrBuilder
      Returns:
      The count of matchedFields.

    • getMatchedFields

      public String getMatchedFields(int index)
      repeated string matched_fields = 23 [json_name = "matchedFields"];
      Specified by:
      getMatchedFields in interface HighlightFieldOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The matchedFields at the given index.

    • getMatchedFieldsBytes

      public com.google.protobuf.ByteString getMatchedFieldsBytes(int index)
      repeated string matched_fields = 23 [json_name = "matchedFields"];
      Specified by:
      getMatchedFieldsBytes in interface HighlightFieldOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the matchedFields at the given index.

    • setMatchedFields

      public HighlightField.Builder setMatchedFields(int index, String value)
      repeated string matched_fields = 23 [json_name = "matchedFields"];
      Parameters:
      index - The index to set the value at.
      value - The matchedFields to set.
      Returns:
      This builder for chaining.

    • addMatchedFields

      public HighlightField.Builder addMatchedFields(String value)
      repeated string matched_fields = 23 [json_name = "matchedFields"];
      Parameters:
      value - The matchedFields to add.
      Returns:
      This builder for chaining.

    • addAllMatchedFields

      public HighlightField.Builder addAllMatchedFields(Iterable<String> values)
      repeated string matched_fields = 23 [json_name = "matchedFields"];
      Parameters:
      values - The matchedFields to add.
      Returns:
      This builder for chaining.

    • clearMatchedFields

      public HighlightField.Builder clearMatchedFields()
      repeated string matched_fields = 23 [json_name = "matchedFields"];
      Returns:
      This builder for chaining.

    • addMatchedFieldsBytes

      public HighlightField.Builder addMatchedFieldsBytes(com.google.protobuf.ByteString value)
      repeated string matched_fields = 23 [json_name = "matchedFields"];
      Parameters:
      value - The bytes of the matchedFields to add.
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final HighlightField.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<HighlightField.Builder>

    • mergeUnknownFields

      public final HighlightField.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<HighlightField.Builder>