Class Highlight.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch.core.search.Highlight.Builder
- All Implemented Interfaces:
ObjectBuilder<Highlight>
- Enclosing class:
- Highlight
public static class Highlight.Builder extends ObjectBuilderBase implements ObjectBuilder<Highlight>
Builder for
Highlight
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description Highlight.Builder
boundaryChars(java.lang.String value)
API name:boundary_chars
Highlight.Builder
boundaryMaxScan(java.lang.Integer value)
API name:boundary_max_scan
Highlight.Builder
boundaryScanner(BoundaryScanner value)
API name:boundary_scanner
Highlight.Builder
boundaryScannerLocale(java.lang.String value)
API name:boundary_scanner_locale
Highlight
build()
Builds aHighlight
.Highlight.Builder
encoder(HighlighterEncoder value)
API name:encoder
Highlight.Builder
fields(java.lang.String key, HighlightField value)
Required - API name:fields
Highlight.Builder
fields(java.lang.String key, java.util.function.Function<HighlightField.Builder,ObjectBuilder<HighlightField>> fn)
Required - API name:fields
Highlight.Builder
fields(java.util.Map<java.lang.String,HighlightField> map)
Required - API name:fields
Highlight.Builder
fragmenter(HighlighterFragmenter value)
API name:fragmenter
Highlight.Builder
fragmentOffset(java.lang.Integer value)
API name:fragment_offset
Highlight.Builder
fragmentSize(java.lang.Integer value)
API name:fragment_size
Highlight.Builder
highlightQuery(Query value)
API name:highlight_query
Highlight.Builder
highlightQuery(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)
API name:highlight_query
Highlight.Builder
maxAnalyzedOffset(java.lang.String value)
API name:max_analyzed_offset
Highlight.Builder
maxFragmentLength(java.lang.Integer value)
API name:max_fragment_length
Highlight.Builder
noMatchSize(java.lang.Integer value)
API name:no_match_size
Highlight.Builder
numberOfFragments(java.lang.Integer value)
API name:number_of_fragments
Highlight.Builder
order(HighlighterOrder value)
API name:order
Highlight.Builder
postTags(java.lang.String value, java.lang.String... values)
API name:post_tags
Highlight.Builder
postTags(java.util.List<java.lang.String> list)
API name:post_tags
Highlight.Builder
preTags(java.lang.String value, java.lang.String... values)
API name:pre_tags
Highlight.Builder
preTags(java.util.List<java.lang.String> list)
API name:pre_tags
Highlight.Builder
requireFieldMatch(java.lang.Boolean value)
API name:require_field_match
Highlight.Builder
tagsSchema(HighlighterTagsSchema value)
API name:tags_schema
Highlight.Builder
type(HighlighterType value)
API name:type
Highlight.Builder
type(java.util.function.Function<HighlighterType.Builder,ObjectBuilder<HighlighterType>> fn)
API name:type
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
fields
Required - API name:fields
Adds all entries of
map
tofields
. -
fields
Required - API name:fields
Adds an entry to
fields
. -
fields
public final Highlight.Builder fields(java.lang.String key, java.util.function.Function<HighlightField.Builder,ObjectBuilder<HighlightField>> fn)Required - API name:fields
Adds an entry to
fields
using a builder lambda. -
type
API name:type
-
type
public final Highlight.Builder type(java.util.function.Function<HighlighterType.Builder,ObjectBuilder<HighlighterType>> fn)API name:type
-
boundaryChars
API name:boundary_chars
-
boundaryMaxScan
API name:boundary_max_scan
-
boundaryScanner
API name:boundary_scanner
-
boundaryScannerLocale
API name:boundary_scanner_locale
-
encoder
API name:encoder
-
fragmenter
API name:fragmenter
-
fragmentOffset
API name:fragment_offset
-
fragmentSize
API name:fragment_size
-
maxFragmentLength
API name:max_fragment_length
-
noMatchSize
API name:no_match_size
-
numberOfFragments
API name:number_of_fragments
-
order
API name:order
-
postTags
API name:post_tags
Adds all elements of
list
topostTags
. -
postTags
API name:post_tags
Adds one or more values to
postTags
. -
preTags
API name:pre_tags
Adds all elements of
list
topreTags
. -
preTags
API name:pre_tags
Adds one or more values to
preTags
. -
requireFieldMatch
API name:require_field_match
-
tagsSchema
API name:tags_schema
-
highlightQuery
API name:highlight_query
-
highlightQuery
public final Highlight.Builder highlightQuery(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)API name:highlight_query
-
maxAnalyzedOffset
API name:max_analyzed_offset
-
build
Builds aHighlight
.- Specified by:
build
in interfaceObjectBuilder<Highlight>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-