Package co.elastic.clients.elasticsearch.core.search

Class Highlight.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch.core.search.HighlightBase.AbstractBuilder<Highlight.Builder>

co.elastic.clients.elasticsearch.core.search.Highlight.Builder

All Implemented Interfaces:

WithJson<Highlight.Builder>, ObjectBuilder<Highlight>

Enclosing class:

Highlight

public static class Highlight.Builder
extends HighlightBase.AbstractBuilder<Highlight.Builder>
implements ObjectBuilder<Highlight>

Builder for Highlight.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Highlight	build()	Builds a Highlight.
final Highlight.Builder	encoder(HighlighterEncoder value)	API name: encoder
final Highlight.Builder	fields(String key, HighlightField value)	Required - API name: fields
final Highlight.Builder	fields(String key, Function<HighlightField.Builder,ObjectBuilder<HighlightField>> fn)	Required - API name: fields
final Highlight.Builder	fields(Map<String,HighlightField> map)	Required - API name: fields
protected Highlight.Builder	self()

Methods inherited from class co.elastic.clients.elasticsearch.core.search.HighlightBase.AbstractBuilder

boundaryChars, boundaryMaxScan, boundaryScanner, boundaryScannerLocale, forceSource, fragmenter, fragmentSize, highlightFilter, highlightQuery, highlightQuery, maxAnalyzedOffset, maxFragmentLength, noMatchSize, numberOfFragments, options, options, order, phraseLimit, postTags, postTags, preTags, preTags, requireFieldMatch, tagsSchema, type, type

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

encoder

public final Highlight.Builder encoder(@Nullable
 HighlighterEncoder value)

API name: encoder

fields

public final Highlight.Builder fields(Map<String,HighlightField> map)

Required - API name: fields

Adds all entries of map to fields.

fields

public final Highlight.Builder fields(String key,
 HighlightField value)

Required - API name: fields

Adds an entry to fields.

fields

public final Highlight.Builder fields(String key,
 Function<HighlightField.Builder,ObjectBuilder<HighlightField>> fn)

Required - API name: fields

Adds an entry to fields using a builder lambda.

self

protected Highlight.Builder self()

Specified by:

self in class HighlightBase.AbstractBuilder<Highlight.Builder>

build

public Highlight build()

Builds a Highlight.

Specified by:

build in interface ObjectBuilder<Highlight>

Throws:

NullPointerException - if some of the required fields are null.