Uses of Class
org.elasticsearch.search.highlight.HighlightBuilder

Packages that use HighlightBuilder

Package	Description
org.elasticsearch.action.percolate
org.elasticsearch.index.query.support
org.elasticsearch.search.aggregations.metrics.tophits
org.elasticsearch.search.builder
org.elasticsearch.search.highlight

Uses of HighlightBuilder in org.elasticsearch.action.percolate

Methods in org.elasticsearch.action.percolate with parameters of type HighlightBuilder

Modifier and Type	Method and Description
PercolateRequestBuilder	PercolateRequestBuilder.setHighlightBuilder(HighlightBuilder highlightBuilder) Delegates to PercolateSourceBuilder.setHighlightBuilder(HighlightBuilder)
PercolateSourceBuilder	PercolateSourceBuilder.setHighlightBuilder(HighlightBuilder highlightBuilder) Enables highlighting for the percolate document.

Uses of HighlightBuilder in org.elasticsearch.index.query.support

Methods in org.elasticsearch.index.query.support that return HighlightBuilder

Modifier and Type	Method and Description
HighlightBuilder	BaseInnerHitBuilder.highlightBuilder()

Uses of HighlightBuilder in org.elasticsearch.search.aggregations.metrics.tophits

Methods in org.elasticsearch.search.aggregations.metrics.tophits that return HighlightBuilder

Modifier and Type	Method and Description
HighlightBuilder	TopHitsBuilder.highlightBuilder()

Uses of HighlightBuilder in org.elasticsearch.search.builder

Methods in org.elasticsearch.search.builder that return HighlightBuilder

Modifier and Type	Method and Description
static HighlightBuilder	SearchSourceBuilder.highlight() A static factory method to construct new search highlights.
HighlightBuilder	SearchSourceBuilder.highlighter()

Methods in org.elasticsearch.search.builder with parameters of type HighlightBuilder

Modifier and Type	Method and Description
SearchSourceBuilder	SearchSourceBuilder.highlight(HighlightBuilder highlightBuilder) Adds highlight to perform as part of the search.

Uses of HighlightBuilder in org.elasticsearch.search.highlight

Methods in org.elasticsearch.search.highlight that return HighlightBuilder

Modifier and Type	Method and Description
HighlightBuilder	HighlightBuilder.boundaryChars(char[] boundaryChars) When using the highlighterType fast-vector-highlighter this setting defines what constitutes a boundary for highlighting.
HighlightBuilder	HighlightBuilder.boundaryMaxScan(Integer boundaryMaxScan) When using the highlighterType fast-vector-highlighter this setting controls how far to look for boundary characters, and defaults to 20.
HighlightBuilder	HighlightBuilder.encoder(String encoder) Set encoder for the highlighting are styled and default.
HighlightBuilder	HighlightBuilder.field(HighlightBuilder.Field field)
HighlightBuilder	HighlightBuilder.field(String name) Adds a field to be highlighted with default fragment size of 100 characters, and default number of fragments of 5 using the default encoder
HighlightBuilder	HighlightBuilder.field(String name, int fragmentSize) Adds a field to be highlighted with a provided fragment size (in characters), and default number of fragments of 5.
HighlightBuilder	HighlightBuilder.field(String name, int fragmentSize, int numberOfFragments) Adds a field to be highlighted with a provided fragment size (in characters), and a provided (maximum) number of fragments.
HighlightBuilder	HighlightBuilder.field(String name, int fragmentSize, int numberOfFragments, int fragmentOffset) Adds a field to be highlighted with a provided fragment size (in characters), and a provided (maximum) number of fragments.
HighlightBuilder	HighlightBuilder.forceSource(boolean forceSource) Forces the highlighting to highlight fields based on the source even if fields are stored separately.
HighlightBuilder	HighlightBuilder.fragmenter(String fragmenter) Sets what fragmenter to use to break up text that is eligible for highlighting.
HighlightBuilder	HighlightBuilder.fragmentSize(Integer fragmentSize) Sets the size of a fragment in characters (defaults to 100)
HighlightBuilder	HighlightBuilder.highlighterType(String highlighterType) Set type of highlighter to use.
HighlightBuilder	HighlightBuilder.highlightFilter(boolean highlightFilter) Set this to true when using the highlighterType fast-vector-highlighter and you want to provide highlighting on filter clauses in your query.
HighlightBuilder	HighlightBuilder.highlightQuery(QueryBuilder highlightQuery) Sets a query to be used for highlighting all fields instead of the search query.
HighlightBuilder	HighlightBuilder.noMatchSize(Integer noMatchSize) Sets the size of the fragment to return from the beginning of the field if there are no matches to highlight and the field doesn't also define noMatchSize.
HighlightBuilder	HighlightBuilder.numOfFragments(Integer numOfFragments) Sets the maximum number of fragments returned
HighlightBuilder	HighlightBuilder.options(Map<String,Object> options) Allows to set custom options for custom highlighters.
HighlightBuilder	HighlightBuilder.order(String order) The order of fragments per field.
HighlightBuilder	HighlightBuilder.phraseLimit(Integer phraseLimit) Sets the maximum number of phrases the fvh will consider if the field doesn't also define phraseLimit.
HighlightBuilder	HighlightBuilder.postTags(String... postTags) Explicitly set the post tags that will be used for highlighting.
HighlightBuilder	HighlightBuilder.preTags(String... preTags) Explicitly set the pre tags that will be used for highlighting.
HighlightBuilder	HighlightBuilder.requireFieldMatch(boolean requireFieldMatch) Set to true to cause a field to be highlighted only if a query matches that field.
HighlightBuilder	HighlightBuilder.tagsSchema(String schemaName) Set a tag scheme that encapsulates a built in pre and post tags.
HighlightBuilder	HighlightBuilder.useExplicitFieldOrder(boolean useExplicitFieldOrder) Send the fields to be highlighted using a syntax that is specific about the order in which they should be highlighted.