Class HighlightField.Builder
- java.lang.Object
-
- org.opensearch.client.util.ObjectBuilderBase
-
- org.opensearch.client.opensearch.core.search.HighlightField.Builder
-
- All Implemented Interfaces:
ObjectBuilder<HighlightField>
- Enclosing class:
- HighlightField
public static class HighlightField.Builder extends ObjectBuilderBase implements ObjectBuilder<HighlightField>
Builder forHighlightField.
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description HighlightField.BuilderboundaryChars(java.lang.String value)API name:boundary_charsHighlightField.BuilderboundaryMaxScan(java.lang.Integer value)API name:boundary_max_scanHighlightField.BuilderboundaryScanner(BoundaryScanner value)API name:boundary_scannerHighlightField.BuilderboundaryScannerLocale(java.lang.String value)API name:boundary_scanner_localeHighlightFieldbuild()Builds aHighlightField.HighlightField.Builderfield(java.lang.String value)API name:fieldHighlightField.BuilderforceSource(java.lang.Boolean value)API name:force_sourceHighlightField.Builderfragmenter(HighlighterFragmenter value)API name:fragmenterHighlightField.BuilderfragmentOffset(java.lang.Integer value)API name:fragment_offsetHighlightField.BuilderfragmentSize(java.lang.Integer value)API name:fragment_sizeHighlightField.BuilderhighlightQuery(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)API name:highlight_queryHighlightField.BuilderhighlightQuery(Query value)API name:highlight_queryHighlightField.BuildermatchedFields(java.lang.String value, java.lang.String... values)API name:matched_fieldsHighlightField.BuildermatchedFields(java.util.List<java.lang.String> list)API name:matched_fieldsHighlightField.BuildermaxFragmentLength(java.lang.Integer value)API name:max_fragment_lengthHighlightField.BuildernoMatchSize(java.lang.Integer value)API name:no_match_sizeHighlightField.BuildernumberOfFragments(java.lang.Integer value)API name:number_of_fragmentsHighlightField.Builderorder(HighlighterOrder value)API name:orderHighlightField.BuilderphraseLimit(java.lang.Integer value)API name:phrase_limitHighlightField.BuilderpostTags(java.lang.String value, java.lang.String... values)API name:post_tagsHighlightField.BuilderpostTags(java.util.List<java.lang.String> list)API name:post_tagsHighlightField.BuilderpreTags(java.lang.String value, java.lang.String... values)API name:pre_tagsHighlightField.BuilderpreTags(java.util.List<java.lang.String> list)API name:pre_tagsHighlightField.BuilderrequireFieldMatch(java.lang.Boolean value)API name:require_field_matchHighlightField.BuildertagsSchema(HighlighterTagsSchema value)API name:tags_schemaHighlightField.Buildertype(java.util.function.Function<HighlighterType.Builder,ObjectBuilder<HighlighterType>> fn)API name:typeHighlightField.Buildertype(HighlighterType value)API name:type-
Methods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
-
-
-
Method Detail
-
boundaryChars
public final HighlightField.Builder boundaryChars(@Nullable java.lang.String value)
API name:boundary_chars
-
boundaryMaxScan
public final HighlightField.Builder boundaryMaxScan(@Nullable java.lang.Integer value)
API name:boundary_max_scan
-
boundaryScanner
public final HighlightField.Builder boundaryScanner(@Nullable BoundaryScanner value)
API name:boundary_scanner
-
boundaryScannerLocale
public final HighlightField.Builder boundaryScannerLocale(@Nullable java.lang.String value)
API name:boundary_scanner_locale
-
field
public final HighlightField.Builder field(@Nullable java.lang.String value)
API name:field
-
forceSource
public final HighlightField.Builder forceSource(@Nullable java.lang.Boolean value)
API name:force_source
-
fragmenter
public final HighlightField.Builder fragmenter(@Nullable HighlighterFragmenter value)
API name:fragmenter
-
fragmentOffset
public final HighlightField.Builder fragmentOffset(@Nullable java.lang.Integer value)
API name:fragment_offset
-
fragmentSize
public final HighlightField.Builder fragmentSize(@Nullable java.lang.Integer value)
API name:fragment_size
-
highlightQuery
public final HighlightField.Builder highlightQuery(@Nullable Query value)
API name:highlight_query
-
highlightQuery
public final HighlightField.Builder highlightQuery(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)
API name:highlight_query
-
matchedFields
public final HighlightField.Builder matchedFields(java.util.List<java.lang.String> list)
API name:matched_fieldsAdds all elements of
listtomatchedFields.
-
matchedFields
public final HighlightField.Builder matchedFields(java.lang.String value, java.lang.String... values)
API name:matched_fieldsAdds one or more values to
matchedFields.
-
maxFragmentLength
public final HighlightField.Builder maxFragmentLength(@Nullable java.lang.Integer value)
API name:max_fragment_length
-
noMatchSize
public final HighlightField.Builder noMatchSize(@Nullable java.lang.Integer value)
API name:no_match_size
-
numberOfFragments
public final HighlightField.Builder numberOfFragments(@Nullable java.lang.Integer value)
API name:number_of_fragments
-
order
public final HighlightField.Builder order(@Nullable HighlighterOrder value)
API name:order
-
phraseLimit
public final HighlightField.Builder phraseLimit(@Nullable java.lang.Integer value)
API name:phrase_limit
-
postTags
public final HighlightField.Builder postTags(java.util.List<java.lang.String> list)
API name:post_tagsAdds all elements of
listtopostTags.
-
postTags
public final HighlightField.Builder postTags(java.lang.String value, java.lang.String... values)
API name:post_tagsAdds one or more values to
postTags.
-
preTags
public final HighlightField.Builder preTags(java.util.List<java.lang.String> list)
API name:pre_tagsAdds all elements of
listtopreTags.
-
preTags
public final HighlightField.Builder preTags(java.lang.String value, java.lang.String... values)
API name:pre_tagsAdds one or more values to
preTags.
-
requireFieldMatch
public final HighlightField.Builder requireFieldMatch(@Nullable java.lang.Boolean value)
API name:require_field_match
-
tagsSchema
public final HighlightField.Builder tagsSchema(@Nullable HighlighterTagsSchema value)
API name:tags_schema
-
type
public final HighlightField.Builder type(@Nullable HighlighterType value)
API name:type
-
type
public final HighlightField.Builder type(java.util.function.Function<HighlighterType.Builder,ObjectBuilder<HighlighterType>> fn)
API name:type
-
build
public HighlightField build()
Builds aHighlightField.- Specified by:
buildin interfaceObjectBuilder<HighlightField>- Throws:
java.lang.NullPointerException- if some of the required fields are null.
-
-